ngodingdocs

API Reference

OpenAPI: Batches

Buat batch (Anthropic)

POST
/v1/messages/batches

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/messages/batches" \  -H "Content-Type: application/json" \  -d '{    "requests": [      {        "custom_id": "string",        "params": {}      }    ]  }'
{  "id": "string",  "type": "message_batch",  "processing_status": "in_progress",  "request_counts": {    "processing": 0,    "succeeded": 0,    "errored": 0,    "canceled": 0,    "expired": 0  },  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "ended_at": "2019-08-24T14:15:22Z",  "cancel_initiated_at": "2019-08-24T14:15:22Z",  "archived_at": null,  "results_url": "string"}

Daftar batch (Anthropic)

GET
/v1/messages/batches

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Query Parameters

limit?integer
Range1 <= value <= 1000
Default20
after_id?string
before_id?string

Gaya Anthropic. Kedua gaya pagination (Anthropic dan OpenAI) diterima di semua daftar (prd/07 §0).

after?string

Gaya OpenAI (id terakhir halaman sebelumnya). Kedua gaya pagination diterima di semua daftar (prd/07 §0).

limit?integer

Gaya OpenAI (1–10000, default 20).

Range1 <= value <= 10000
Default20
order?string

Gaya OpenAI (default desc).

Default"desc"

Value in

  • "asc"
  • "desc"

Response Body

application/json

curl -X GET "https://example.com/v1/messages/batches"
{}

Detail batch (Anthropic)

GET
/v1/messages/batches/{id}

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/messages/batches/string"
{  "id": "string",  "type": "message_batch",  "processing_status": "in_progress",  "request_counts": {    "processing": 0,    "succeeded": 0,    "errored": 0,    "canceled": 0,    "expired": 0  },  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "ended_at": "2019-08-24T14:15:22Z",  "cancel_initiated_at": "2019-08-24T14:15:22Z",  "archived_at": null,  "results_url": "string"}

Hapus batch (hanya bila ended)

DELETE
/v1/messages/batches/{id}

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X DELETE "https://example.com/v1/messages/batches/string"
{  "id": "string",  "type": "message_batch",  "processing_status": "in_progress",  "request_counts": {    "processing": 0,    "succeeded": 0,    "errored": 0,    "canceled": 0,    "expired": 0  },  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "ended_at": "2019-08-24T14:15:22Z",  "cancel_initiated_at": "2019-08-24T14:15:22Z",  "archived_at": null,  "results_url": "string"}

Batalkan batch (Anthropic)

POST
/v1/messages/batches/{id}/cancel

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Path Parameters

id*string

Response Body

application/json

curl -X POST "https://example.com/v1/messages/batches/string/cancel"
{  "id": "string",  "type": "message_batch",  "processing_status": "in_progress",  "request_counts": {    "processing": 0,    "succeeded": 0,    "errored": 0,    "canceled": 0,    "expired": 0  },  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "ended_at": "2019-08-24T14:15:22Z",  "cancel_initiated_at": "2019-08-24T14:15:22Z",  "archived_at": null,  "results_url": "string"}

Hasil batch JSONL (Anthropic)

GET
/v1/messages/batches/{id}/results

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Path Parameters

id*string

Response Body

application/jsonl

curl -X GET "https://example.com/v1/messages/batches/string/results"
"string"

Buat batch (OpenAI)

POST
/v1/batches

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/batches" \  -H "Content-Type: application/json" \  -d '{    "input_file_id": "string",    "endpoint": "/v1/chat/completions",    "completion_window": "24h"  }'
{  "id": "string",  "object": "batch",  "endpoint": "/v1/chat/completions",  "completion_window": "24h",  "status": "validating",  "input_file_id": "string",  "output_file_id": "string",  "error_file_id": "string",  "created_at": 0,  "request_counts": {    "total": 0,    "completed": 0,    "failed": 0  },  "metadata": {}}

Daftar batch (OpenAI)

GET
/v1/batches

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Query Parameters

after?string

Gaya OpenAI (id terakhir halaman sebelumnya). Kedua gaya pagination diterima di semua daftar (prd/07 §0).

limit?integer

Gaya OpenAI (1–10000, default 20).

Range1 <= value <= 10000
Default20
order?string

Gaya OpenAI (default desc).

Default"desc"

Value in

  • "asc"
  • "desc"
limit?integer
Range1 <= value <= 1000
Default20
after_id?string
before_id?string

Gaya Anthropic. Kedua gaya pagination (Anthropic dan OpenAI) diterima di semua daftar (prd/07 §0).

Response Body

application/json

curl -X GET "https://example.com/v1/batches"
{}

Detail batch (OpenAI)

GET
/v1/batches/{id}

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/batches/string"
{  "id": "string",  "object": "batch",  "endpoint": "/v1/chat/completions",  "completion_window": "24h",  "status": "validating",  "input_file_id": "string",  "output_file_id": "string",  "error_file_id": "string",  "created_at": 0,  "request_counts": {    "total": 0,    "completed": 0,    "failed": 0  },  "metadata": {}}

Batalkan batch (OpenAI)

POST
/v1/batches/{id}/cancel

Authorization

AuthorizationBearer <token>

Kunci inference sk-ngd- + 40 karakter base62. Plaintext hanya ditampilkan sekali saat dibuat di dashboard.

In: header

Path Parameters

id*string

Response Body

application/json

curl -X POST "https://example.com/v1/batches/string/cancel"
{  "id": "string",  "object": "batch",  "endpoint": "/v1/chat/completions",  "completion_window": "24h",  "status": "validating",  "input_file_id": "string",  "output_file_id": "string",  "error_file_id": "string",  "created_at": 0,  "request_counts": {    "total": 0,    "completed": 0,    "failed": 0  },  "metadata": {}}