Skip to main content
POST
/
v1
/
async
/
rerank
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "status_code": 123,
  "result": "<unknown>",
  "error": {
    "event_id": "<string>",
    "type": "<string>",
    "is_bifrost_error": true,
    "status_code": 123,
    "error": {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "param": "<string>",
      "event_id": "<string>"
    },
    "extra_fields": {
      "provider": "openai",
      "model_requested": "<string>",
      "request_type": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-bf-async-job-result-ttl
integer
default:3600

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.

Body

application/json
​
model
string
required

Model in provider/model format

Example:

"cohere/rerank-v3.5"

​
query
string
required

Query used to score and reorder documents

Minimum string length: 1
​
documents
object[]
required

Documents to rerank

Minimum array length: 1
​
fallbacks
string[]

Fallback models in provider/model format

​
top_n
integer

Maximum number of ranked results to return

Required range: x >= 1
​
max_tokens_per_doc
integer

Maximum tokens to consider per document (provider-dependent)

Required range: x >= 1
​
priority
integer

Request priority hint (provider-dependent)

​
return_documents
boolean

Whether to include document content in each result

Response

Job accepted for processing

Response returned when creating or polling an async job

​
id
string
required

Unique identifier for the async job

​
status
enum<string>
required

The status of an async job

Available options:
pending,
processing,
completed,
failed
​
created_at
string<date-time>
required

When the job was created

​
expires_at
string<date-time>

When the job result expires and will be cleaned up

​
completed_at
string<date-time>

When the job completed (successfully or with failure)

​
status_code
integer

HTTP status code of the completed operation

​
result
any

The result of the completed operation (shape depends on the request type)

​
error
object

Error response from Bifrost