Skip to main content
POST
/
v1
/
comparisons
Run a multi-model comparison (async)
curl --request POST \
  --url https://api.rimp.io/v1/comparisons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "models": [
    "<string>"
  ],
  "params_shared": {}
}
'
{
  "id": "<string>",
  "prompt": "<string>",
  "params_shared": {},
  "reserved_credits": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "generations": [
    {
      "id": "<string>",
      "model": "<string>",
      "status": "<string>",
      "charged_credits": 123,
      "refunded_credits": 123,
      "error_code": "<string>",
      "outputs": [
        {
          "id": "<string>",
          "mime": "<string>",
          "width": 123,
          "height": 123,
          "duration_s": "<string>",
          "url": "<string>"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://rimp.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
prompt
string
required
Maximum string length: 4000
models
string[]
required
Required array length: 2 - 12 elements
params_shared
object

Response

Comparison queued. Poll /v1/comparisons/{id} or subscribe via webhook.

id
string
object
enum<string>
Available options:
comparison
status
enum<string>
Available options:
queued,
running,
succeeded,
partial,
failed
prompt
string
params_shared
object
reserved_credits
integer
created_at
string<date-time>
finished_at
string<date-time> | null
generations
object[]