Documentation

Upload file

POST
/api/v1/external/inference/files

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB

AutorisationBearer <jeton>

Clé API d'organisation (model key ou agent key), créée depuis la console Oreus ou l'API Third-Party. Ce n'est pas le jeton OIDC.

Dans: header

Paramètres d’en-tête

x-oreus-user-authorization?string

Optionnel. Bearer <JWT d'organisation> de l'utilisateur connecté, obtenu via le flow OIDC avec les scopes read:inference / write:inference. Présent, l'appel est facturé à cet utilisateur en orbs plutôt qu'à l'organisation propriétaire de la clé API. Le jeton doit avoir été émis pour une application third-party de la même organisation que la clé.

Corps de requête

multipart/form-data

Définitions TypeScript

Utilisez le type request body en TypeScript.

file*string

The File object (not file name) to be uploaded

purpose*"user_data"

The intended purpose of the uploaded file

Valeur parmi

  • "user_data"

Corps de réponse

application/json

curl -X POST "https://example.com/api/v1/external/inference/files" \  -F file="string" \  -F purpose="user_data"
{  "id": "file-abc123",  "created_at": 1699017600,  "purpose": "assistants",  "bytes": 1024,  "object": "file",  "filename": "file.jsonl",  "expires_at": null,  "expires_after": {    "anchor": "string",    "seconds": 0  }}