Async Jobs

Create async embedding

Submits an embedding request for asynchronous execution. Returns a job ID immediately with HTTP 202. Poll the corresponding GET endpoint with the job ID to retrieve the result.

post/v1/async/embeddings

Request

Base URL
http://localhost:8080
Auth
- HTTP bearer
- or HTTP basic
- or API key in header x-bf-vk
- or API key in header x-api-key
TypeScript
https://skmtc.dev/getbifrost/apis/bifrost-api/docs/v1/async/embeddings/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

x-bf-async-job-result-ttlinteger

Time-to-live in seconds for the job result after completion. Defaults to 3600 (1 hour). After expiry, the job result is automatically cleaned up.

x-bf-async-webhookstring

Name of a registered webhook endpoint to notify when this job reaches a terminal state (completed or failed). The endpoint must already exist and be enabled; otherwise the submission is rejected with HTTP 400. If the endpoint is not subscribed to the resulting event, the job still completes normally but no delivery is enqueued. When omitted, no webhook is sent for the job and results are retrieved by polling. See the Webhooks management API to register endpoints.

Request body

modelstring required

Model in provider/model format

fallbacksstring[]

encoding_format'float' | 'base64'

dimensionsinteger

Response

Job accepted for processing

idstring required

Unique identifier for the async job

status'pending' | 'processing' | 'completed' | 'failed' required

The status of an async job

expires_atstring date-time

When the job result expires and will be cleaned up

created_atstring date-time required

When the job was created

completed_atstring date-time

When the job completed (successfully or with failure)

status_codeinteger

HTTP status code of the completed operation

resultunknown

Changes

No recorded changes to this operation across all 1 revision of this API.