Skip to main content

FastAPI (0.1.0)

Download OpenAPI specification:Download

Authentication

OAuth2PasswordBearerHeaderOrCookie

Security Scheme Type OAuth2
password OAuth Flow
Token URL: /token

APIKeyHeader

Security Scheme Type API Key
Header parameter name: X-API-KEY

Server Status

Retrieve the current server time

Responses

Response samples

Content type
application/json
null

Predict

Use the latest model for the given project to predict on a batch of datapoints and return the result

path Parameters
project_id
required
integer (Project Id)
Request Body schema: application/json
batch_id
required
string (User-provided batch ID)
required
Array of objects (An array of data containing the input fields defined by your project and any additional key-value meta-data you wish to record for a prediction such as your document ids.) [ items ]

Responses

Request samples

Content type
application/json
{
  • "batch_id": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "project_id": 0,
  • "predictions": [
    ]
}

Score

Use the latest model for the given project to score on a batch of datapoints and return the result

path Parameters
project_id
required
integer (Project Id)
Request Body schema: application/json
batch_id
required
string (User-provided batch ID)
required
Array of objects (An array of data containing the input fields defined by your project and any additional key-value meta-data you wish to record for a prediction such as your document ids.) [ items ]

Responses

Request samples

Content type
application/json
{
  • "batch_id": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "project_id": 0,
  • "scores": [
    ]
}