Files

Parts list: Routes and fields

1. 01
   POST /v1/files

   multipart/form-data with file and purpose batch; any other purpose is a 400 invalid_value. The optional expires_after[anchor] (created_at) and expires_after[seconds] (3,600 to 2,592,000: one hour to 30 days) come together or not at all. The file is checked as it arrives: at most 200 MB (file_too_large); UTF-8 JSON Lines, one object per line, not empty, at most 50,000 lines, every line naming the same model and the same url, and no line naming a router (invalid_file_format, the message naming the first line at fault). Takes idempotency-key.

2. 02
   GET /v1/files

   OpenAI's list (data, first_id, last_id, has_more) with after, limit, order and purpose (batch or batch_output).

3. 03
   GET /v1/files/{file_id}/content

   The bytes, streamed from storage through the gateway, application/jsonl for an input, output or error file.

4. 04
   DELETE /v1/files/{file_id}

   {"id": "file_...", "object": "file", "deleted": true}; the object is deleted from storage at once. Deleting the input file of a batch that has not ended cancels that batch.

5. 05
   purpose

   batch for an uploaded input; batch_output for a batch's output and error files, which HIPS writes. Once Knowledge is switched on, also user_data for a knowledge base's document (assistants taken as its alias): uploaded by a full key or a person whose role writes, kept until it is deleted or its expires_after passes, a stored object at the storage price while kept, at most a number of such files a workspace Not decided yet (past it, 400 limit_reached), and named in a knowledge base alone.

6. 06
   expires_at

   30 days after created_at by default, sooner by expires_after or a batch's output_expires_after. An expired or deleted file answers 404 file_not_found.

7. 07
   Who reads a file

   A full key reads every file of its workspace; an inference_only key and a person's token the files they created; a retrieval key only the workspace's batch output and error files.

• Status

  400

  Type

  invalid_request_error

  Code

  invalid_value

  Situation

  A value is out of range or malformed: stop with more than 16 entries, a prompt_cache_key over 512 characters, a string holding a lone surrogate escape, a router name with an empty or unknown suffix, both max_tokens names with different values

  Retry

  No

• Status

  400

  Type

  invalid_request_error

  Code

  invalid_idempotency_key, idempotency_key_reused, idempotency_in_progress

  Situation

  The idempotency rules

  Retry

  The last one, later

• Status

  400

  Type

  invalid_request_error

  Code

  file_too_large, invalid_file_format, batch_not_offered

  Situation

  A batch input file over 200 MB; one that is not UTF-8 JSON Lines of objects, is empty, holds more than 50,000 lines, or names more than one model, one url or a router (the message names the first line at fault); a batch of a model sold without batch. Batches and files are not offered in production yet

  Retry

  No

• Status

  403

  Type

  permission_error

  Code

  key_scope_denied

  Situation

  The key's kind excludes the route: a retrieval key on any route but its batch and file reads; a key other than full writing a knowledge base's documents

  Retry

  No

• Status

  404

  Type

  not_found_error

  Code

  upload_not_found, file_not_found, batch_not_found

  Situation

  An id in the path, or input_file_id, that is unknown, deleted, expired, another workspace's, or out of the credential's reach. Batches and files are not offered in production yet

  Retry

  No

• Status

  404

  Type

  not_found_error

  Code

  route_not_available

  Situation

  A route that is built and not offered on this gateway: uploads, files and batches in production, and POST /v1/messages/count_tokens

  Retry

  No