Async Jobs

Create async rerank

Submits a rerank 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.

Authorization

AuthorizationBearer <token>

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

In: header

Header Parameters

x-bf-async-job-result-ttl?integer

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.

Default3600

Request Body

modelstring

Model in provider/model format

querystring

Query used to score and reorder documents

Length1 <= length

documentsarray<RerankDocument>

Documents to rerank

Items1 <= items

fallbacks?array<string>

Fallback models in provider/model format

top_n?integer

Maximum number of ranked results to return

Range1 <= value

max_tokens_per_doc?integer

Maximum tokens to consider per document (provider-dependent)

Range1 <= value

priority?integer

Request priority hint (provider-dependent)

return_documents?boolean

Whether to include document content in each result

Response Body

curl -X POST "http://localhost:8080/v1/async/rerank" \
  -H "x-bf-async-job-result-ttl: 3600" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "cohere/rerank-v3.5",
    "query": "string",
    "documents": [
      {
        "text": "string"
      }
    ]
  }'

curl -X POST "http://localhost:8080/v1/async/rerank" \  -H "x-bf-async-job-result-ttl: 3600" \  -H "Content-Type: application/json" \  -d '{    "model": "cohere/rerank-v3.5",    "query": "string",    "documents": [      {        "text": "string"      }    ]  }'

{
  "id": "string",
  "status": "pending",
  "expires_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "status_code": 0,
  "result": null,
  "error": {
    "event_id": "string",
    "type": "string",
    "is_bifrost_error": true,
    "status_code": 0,
    "error": {
      "type": "string",
      "code": "string",
      "message": "string",
      "param": "string",
      "event_id": "string"
    },
    "extra_fields": {
      "provider": "openai",
      "model_requested": "string",
      "request_type": "string"
    }
  }
}

{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}

{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}

Create async OCR job Create async response

On this page

No Headings