Create a prediction

POST

predictions

Create a prediction

curl --request POST \
  --url https://d1-staging-5gh8d.ondigitalocean.app/v1/predictions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "context": "<string>",
  "questions": [
    {
      "id": "<string>",
      "prompt": "<string>",
      "type": "binary"
    }
  ],
  "model": "default"
}
'

import requests

url = "https://d1-staging-5gh8d.ondigitalocean.app/v1/predictions"

payload = {
    "context": "<string>",
    "questions": [
        {
            "id": "<string>",
            "prompt": "<string>",
            "type": "binary"
        }
    ],
    "model": "default"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    context: '<string>',
    questions: [{id: '<string>', prompt: '<string>', type: 'binary'}],
    model: 'default'
  })
};

fetch('https://d1-staging-5gh8d.ondigitalocean.app/v1/predictions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "answers": [
    {
      "id": "<string>",
      "probability_true": 0.5,
      "type": "binary"
    }
  ],
  "model": "<string>",
  "request_id": "<string>",
  "usage": {
    "cost_usd": "<string>",
    "input_tokens": 1,
    "metering_version": "<string>",
    "pricing_version": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string | null

Optional, recommended unique operation key (at most 200 characters). Keep the same key and request for retries after a lost response. Changed content conflicts; accepted terminal results replay for 24 hours by default, followed by a tombstone until 30 days from acceptance. Never recycle a key for a new logical operation.

Body

application/json

context

required

questions

(BinaryQuestion · object | ChoiceQuestion · object | ScoreQuestion · object)[]

required

Required array length: 1 - 16 elements

BinaryQuestion
ChoiceQuestion
ScoreQuestion

Show child attributes

model

string

default:default

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_.-]+$

Response

Successful Response

answers

(BinaryAnswer · object | ChoiceAnswer · object | ScoreAnswer · object)[]

required

BinaryAnswer
ChoiceAnswer
ScoreAnswer

Show child attributes

model

string

required

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_.-]+$

request_id

string

required

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_.-]+$

usage

Usage · object

required

Show child attributes

Create a prediction

curl --request POST \
  --url https://d1-staging-5gh8d.ondigitalocean.app/v1/predictions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "context": "<string>",
  "questions": [
    {
      "id": "<string>",
      "prompt": "<string>",
      "type": "binary"
    }
  ],
  "model": "default"
}
'

import requests

url = "https://d1-staging-5gh8d.ondigitalocean.app/v1/predictions"

payload = {
    "context": "<string>",
    "questions": [
        {
            "id": "<string>",
            "prompt": "<string>",
            "type": "binary"
        }
    ],
    "model": "default"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    context: '<string>',
    questions: [{id: '<string>', prompt: '<string>', type: 'binary'}],
    model: 'default'
  })
};

fetch('https://d1-staging-5gh8d.ondigitalocean.app/v1/predictions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "answers": [
    {
      "id": "<string>",
      "probability_true": 0.5,
      "type": "binary"
    }
  ],
  "model": "<string>",
  "request_id": "<string>",
  "usage": {
    "cost_usd": "<string>",
    "input_tokens": 1,
    "metering_version": "<string>",
    "pricing_version": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

Account

Models

Predictions

Create a prediction

Authorizations

Headers

Body

Response