POST Document

post

https://api.conveyor.com/api/v2/exchange/documents

Creates a document.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Please note, the file size limit is 100MB.

Query Params

name

string

required

Name of the document

file

required

The document file to upload

description

string

Description of the document

certification

string

enum

Certification type (badge) of the document

featured

boolean

Defaults to false

When set to true, this document will be 'featured' on a public profile

folder_id

string

UUID of the folder to place the document in

access_level

string

enum

Access level of the document

Allowed:

product_line_ids

string

Comma-separated Product Line UUIDs. These are the applicable product lines for the document. Leave blank if applicable to all product lines.

access_group_ids

string

Comma-separated Access Group UUIDs

disable_downloads

boolean

Defaults to false

Disable downloads for this document

use_for_question_answering

boolean

Defaults to false

Use this document for question answering. If not provided, it will be automatically determined based on whether the document can be used for question answering.

expires_at

string

Expiration date in ISO 8601 format (e.g. 2026-12-31).

curator_id

string

Document owner/curator. Must be a user in your org. Cannot be combined with curator_email unless they match.

curator_email

string

Alternative to curator_id. Resolved to a user in your org. Cannot be combined with curator_id unless they match.

Headers

X-API-KEY

string

Your Conveyor API key

Response

201201