Skip to content

Test Provider

POST
/api/settings/providers/{provider_id}/test
curl --request POST \
--url http://localhost:8000/api/settings/providers/example/test \
--header 'Authorization: Bearer <token>'

Send a test prompt to the provider and return the response.

provider_id
required
Provider Id
string

Successful Response

Media typeapplication/json
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}