Files

File upload and management endpoints.

List files (OpenAI-compatible)

get

List files owned by the authenticated project, optionally filtered by purpose.

Authorizations

AuthorizationstringRequired

API key in Authorization header using Bearer .

Query parameters

purposestring · nullableOptional

Filter by purpose

limitinteger · min: 1 · max: 1000Optional

Max number of files.

Default: 100

offsetintegerOptional

Number of files to skip.

Default: 0

Responses

200

Successful Response

application/json

OpenAI-compatible list response for files.

objectconst: listOptional

Object type identifier.

Default: list

totalintegerRequired

Total number of items available for this resource.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Validation Error

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Upstream Unavailable

application/json

get/v1/files

GET /v1/files HTTP/1.1
Host: platform.maniac.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "object": "list",
  "data": [
    {
      "bytes": 1200,
      "created_at": 1710000000,
      "filename": "training.jsonl",
      "id": "file-123",
      "object": "file",
      "purpose": "fine-tune",
      "status": "uploaded"
    }
  ],
  "total": 0
}

Upload a file

post

Upload a file to the platform. This endpoint accepts a file and a purpose, and uploads the file to the platform, for later use in training or evaluation.

Authorizations

AuthorizationstringRequired

API key in Authorization header using Bearer .

Body

purposestringRequired

filestring · binaryRequired

Responses

201

Successful Response

application/json

OpenAI-compatible file object (subset).

We keep id as the DB UUID string, and expose the OpenAI-ish envelope.

idstringRequired

File id (UUID).

objectconst: fileOptional

Object type.

Default: file

bytesintegerRequired

File size in bytes.

created_atintegerRequired

Unix timestamp (seconds).

filenamestringRequired

Original filename.

purposestringRequired

Intended file purpose.

statusstringRequired

Current file status.

status_detailsstring · nullableOptional

Optional status details.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

Conflict

application/json

422

Validation Error

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Upstream Unavailable

application/json

post/v1/files

POST /v1/files HTTP/1.1
Host: platform.maniac.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 34

{
  "purpose": "text",
  "file": "binary"
}

{
  "bytes": 1200,
  "created_at": 1710000000,
  "filename": "training.jsonl",
  "id": "file-123",
  "object": "file",
  "purpose": "fine-tune",
  "status": "uploaded"
}

Retrieve file metadata

get

Fetch metadata for a single file by id within the authenticated project.

Authorizations

AuthorizationstringRequired

API key in Authorization header using Bearer .

Path parameters

file_idstringRequired

File id (UUID)

Responses

200

Successful Response

application/json

OpenAI-compatible file object (subset).

We keep id as the DB UUID string, and expose the OpenAI-ish envelope.

idstringRequired

File id (UUID).

objectconst: fileOptional

Object type.

Default: file

bytesintegerRequired

File size in bytes.

created_atintegerRequired

Unix timestamp (seconds).

filenamestringRequired

Original filename.

purposestringRequired

Intended file purpose.

statusstringRequired

Current file status.

status_detailsstring · nullableOptional

Optional status details.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Validation Error

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Upstream Unavailable

application/json

get/v1/files/{file_id}

GET /v1/files/{file_id} HTTP/1.1
Host: platform.maniac.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "bytes": 1200,
  "created_at": 1710000000,
  "filename": "training.jsonl",
  "id": "file-123",
  "object": "file",
  "purpose": "fine-tune",
  "status": "uploaded"
}

Delete a file (OpenAI-compatible)

delete

Soft-delete a file by id within the authenticated project.

Authorizations

AuthorizationstringRequired

API key in Authorization header using Bearer .

Path parameters

file_idstringRequired

File id (UUID)

Responses

200

Successful Response

application/json

OpenAI-compatible delete response.

idstringRequired

File id (UUID).

objectconst: fileOptional

Object type.

Default: file

deletedbooleanOptional

Deletion status.

Default: true

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Validation Error

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Upstream Unavailable

application/json

delete/v1/files/{file_id}

DELETE /v1/files/{file_id} HTTP/1.1
Host: platform.maniac.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "object": "file",
  "deleted": true
}

Retrieve file content (OpenAI-compatible)

get

Download the raw contents of a file by id within the authenticated project.

Authorizations

AuthorizationstringRequired

API key in Authorization header using Bearer .

Path parameters

file_idstringRequired

File id (UUID)

Responses

200

Raw file bytes

anyOptional

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Validation Error

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Upstream Unavailable

application/json

get/v1/files/{file_id}/content

GET /v1/files/{file_id}/content HTTP/1.1
Host: platform.maniac.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

PreviousContainers NextModels

Last updated 2 months ago