API Reference

Create resource

post
https://expert.inskill.ai/public/apiv3/resources

Create a new resource

Required Fields:

  • name: Resource name. Defaults to the file name when a file is uploaded.
  • url: Resource URL. Set automatically for file uploads and dynamic resources.
  • type: Resource type (0=URL, 1=Document, 2=Image, 3=Video, 4=Dynamic)

Translations are not accepted on create. Add them afterwards with PATCH /resources/{id} or POST /resources/{id}/upload?language={lang}.

Resource Scope:

  • Account Resources: Omit both product_id and asset_id
  • Product Resources: Provide product_id, omit asset_id
  • Asset Resources: Provide asset_id, omit product_id

Content Requirements by Type:

  • URL resources (type=0): Provide url field
  • Dynamic resources (type=4): Provide body field (markdown content)
  • Document/Image/Video (types=1,2,3): Upload file via file parameter

File Upload Format:
For resources with file uploads, use multipart/form-data.
For URL and dynamic resources without files, both application/json and multipart/form-data are supported.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null

Dynamic step body (Dynamic resources only)

string | null

Shorthand string form of a single dependency condition: components.{product_id}.{variable} = {value}. Operators: =, !=, >, <; multiple target values are comma-separated. On write, it is expanded to the equivalent dependencies array; on read, it is the string rendering of dependencies. For multiple conditions or AND/OR logic, use dependencies. See the Dependencies reference.

string | null

External ID (max 256 chars)

keywords
array of strings | null
keywords
metadata
object | null

Custom metadata as JSON object (e.g., version info, issue numbers)

string | null

Custom description providing additional context to GPT about this resource.
Provides additional context to the AI when this resource is retrieved during conversations.
This field is user-facing and editable via the web UI.

string | null

Custom prompt injected when this resource is used by GPT.
Controls how the AI should interpret or present information from this resource during conversations.
This field is user-facing and editable via the web UI.

integer | null
enum
Defaults to 0

GPT indexing mode. Controls how this resource is processed for AI-powered search and retrieval.

  • 0: DISABLED - Resource not indexed by GPT
  • 1: INDEX - Index only, no content parsing
  • 2: PARSE - Full content parsing with embeddings (default for documents/videos)

Note: Images and URLs default to DISABLED. Documents and videos default to PARSE.

Allowed:
string

Name

roles
array of integers | null

Access levels that can view this resource. These are fixed levels, not role IDs from GET /roles.

Valid values:

  • 0: User (basic role)
  • 1: Tech (Tier 1)
  • 2: Tech2 (Tier 2)
  • 3: Tech3 (Tier 3)
  • 5: Expert
  • 7: User2
  • 8: User3

Any other value is silently dropped. If omitted, defaults to all levels [0, 1, 2, 3, 5, 7, 8].

roles
integer
enum
Defaults to 1

Status (0=unpublished/inactive, 1=published/active)

Allowed:
tags
object | null

Resource tags (JSON object)

translations
object

Translations for the resource. Keys are language codes (e.g., 'fr', 'es', 'de').

Two ways to add translations:

  • Metadata only (no file): Use PATCH /resources/{id} with a translations object. Use this when the translation shares the English file (multilingual PDF) or when you only need to set the translated title.
  • With a translated file: Use POST /resources/{id}/upload?language={lang} with the file in a multipart form. This uploads the translated file and stores it on the translation record. You can also pass name in the form data to set the translated title.
integer
enum

Resource type:

  • 0: URL
  • 1: Document (PDF, DOC, etc.)
  • 2: Image (JPG, PNG, etc.)
  • 3: Video (MP4, MOV, etc.)
  • 4: Dynamic (for dynamic resources)
Allowed:
uri

URL

integer
enum
Defaults to 1

Visibility in mobile app (0=hidden, 1=visible)

Allowed:
integer
enum
Defaults to 1

Visibility to GPT chatbot (0=not indexed, 1=indexed for RAG).
When set to 0, this resource will not be used by the AI when answering questions.

Allowed:
integer
enum
Defaults to 1

Visibility on web platform (0=hidden, 1=visible)

Allowed:
integer

Asset ID

integer

Product ID

file

File to upload

Responses

Updated 6 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago