POST
/
sources

Authorizations

Authorization
string
headerrequired

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Body

application/json
__typename
enum<string>
required

Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.

Available options:
CreateDocumentSourceRequest
content_length
integer
required

The size (in bytes) of the file that will be uploaded. This must also be passed as a 'content-length' header during the upload. The pre-signed URL will only accept a file of this size.

Required range: x < 50000000
content_type
enum<string>
required

The content type of the file that will be uploaded. This must also be passed as a 'content-type' header during the upload. The pre-signed URL will only accept a file of this content-type.

Available options:
application/pdf,
image/jpeg,
image/png,
text/plain,
application/vnd.ms-excel,
application/msword,
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,
application/vnd.openxmlformats-officedocument.wordprocessingml.document
display_name
string
required
Required string length: 1 - 100
file_name
string
required

The full name of the file that will be uploaded, including it's file extension

published_at
string
required
supplier_reference_id
string
required
Maximum length: 100
is_public
boolean
default: false

If the source document should be publicly available on the Registry once credits are issued.

Response

200 - application/json
signed_upload_url
string
required

A presigned upload URL, which must be used to upload the document associated with this source.

source
object
required

Was this page helpful?

Post Signed Upload UrlPatch Source