---
url: /apidocs/partner_resource_info.md
---
## Partner: ResourceInfo API

| Endpoint | Method | Description |
|-----|-----|-----|
| [/api/v0/partnerRpc/resourceInfo.getResourceById](#get-resource-by-id) | jsonRpc | Get resource by id |
| [/api/v0/partnerRpc/resourceInfo.getResourceUrl](#get-resource-url) | jsonRpc | Get resource url |
| [/api/v0/partnerRpc/resourceInfo.updateResourceEnrichment](#update-resource-enrichment) | jsonRpc | Update resource enrichment |
| [/api/v0/partnerRpc/resourceInfo.setBelongingIndexState](#set-belonging-index-state) | jsonRpc | Set belonging index state |
| [/api/v0/partnerRpc/resourceInfo.fetchPendingJobs](#fetch-pending-jobs) | jsonRpc | Fetch pending jobs |
| [/api/v0/partnerRpc/resourceInfo.completeJob](#complete-job) | jsonRpc | Complete job |
| [/api/v0/partnerRpc/resourceInfo.checkUserCanViewBelonging](#check-user-can-view-belonging) | jsonRpc | Check user can view belonging |
| [/api/v0/partnerRpc/resourceInfo.checkUserCanViewResource](#check-user-can-view-resource) | jsonRpc | Check user can view resource |
| [/api/v0/partnerRpc/resourceInfo.searchBelonging](#search-belonging) | jsonRpc | Search belonging |
| [/api/v0/partnerRpc/resourceInfo.listParentDirectories](#list-parent-directories) | jsonRpc | List parent directories |

### Get resource by id

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.getResourceById

**Description:** API returns resource metadata by its id.

**Request:**

**Response:**

### Get resource url

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.getResourceUrl

**Description:** API returns direct URL to resource file data.

**Request:**

**Response:**

### Update resource enrichment

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.updateResourceEnrichment

**Description:** API updates resource after AI enrichment.

**Request:**

**Response:**

### Set belonging index state

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.setBelongingIndexState

**Description:** API sets indexation state of a belonging (filled by RAG).

**Request:**

**Response:**

### Fetch pending jobs

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.fetchPendingJobs

**Description:** API returns pending resource enrichment jobs to process. Each returned job is leased - call resourceInfo.completeJob to report the outcome, or it becomes fetchable again once the lease expires.

**Request:**

**Response:**

### Complete job

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.completeJob

**Description:** API reports the outcome of a resource enrichment job: success completes it, failure either requeues it for retry or dead-letters it once attempts are exhausted. Idempotent - completing an already-terminal job again is a no-op, not an error.

**Request:**

**Response:**

### Check user can view belonging

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.checkUserCanViewBelonging

**Description:** API return no error if user has permission to view belonging resources.

**Request:**

**Response:**

### Check user can view resource

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.checkUserCanViewResource

**Description:** API return no error if user has permission to view resource.

**Request:**

**Response:**

### Search belonging

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.searchBelonging

**Description:** API returns resources by its belonging.

**Request:**

**Response:**

### List parent directories

**Method:** jsonRpc

**HTTP Method:** POST

**Path:** /api/v0/partnerRpc/resourceInfo.listParentDirectories

**Description:** API returns parent directories for resource, from top to bottom.

**Request:**

**Response:**

## Models

#### Resource

#### Resource Origin

#### Geolocation

#### Dimensions

#### Resource Data Audio

#### Resource Data Video

#### Resource Data Amazon

#### Resource Data Imdb

#### Resource Data Youtube

#### Resource Data Vimeo

#### Resource Data Pinterest

#### Resource Data Pixabay

#### Resource Data Facebook

#### Resource Data Remote Url

#### Live Stream Data

#### AI Generation Data

#### Resource Data Directory

#### Google Drive

#### Channel Data

#### Enrichment Data

#### Programmatic Action with children

#### Programmatic Action