Create Destination

POSThttps://api.confident-ai.com/v2/export-destinations

Creates an export destination in your Confident AI project and returns its id. Credentials must be sent in full — a masked value copied from a read is rejected, since storing the mask would leave a destination that can never authenticate. A project holds at most three destinations.

POST/v2/export-destinations

curl -X POST "https://api.confident-ai.com/v2/export-destinations" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Nightly S3 exports",
  "type": "S3",
  "bucket": "acme-llm-exports",
  "region": "us-east-1",
  "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
  "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  "pathPrefix": "confident-ai/",
  "enabled": true
}'

200

{
  "success": true,
  "data": {
    "id": "<EXPORT-DESTINATION-ID>"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/project-settings/exports",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request body

namestringRequired
The name of the destination, as it appears in your project.
typeenum
The kind of storage exports are uploaded to. Only S3 is supported today, and any other member is rejected on create and update.
Show 4 enum valuesHide 4 enum values
- S3
- GCS
- AZURE_BLOB
- SNOWFLAKE
bucketstringRequired
The name of the bucket exports are uploaded to.
regionstringRequired
The region the bucket lives in.
accessKeyIdstringRequired
The access key id Confident AI uploads with. Reads return this masked, as fifteen asterisks followed by its last six characters, so a masked value is rejected here — send the real key id.
secretAccessKeystringRequired
The secret access key paired with accessKeyId. Confident AI never returns it in full, so a masked value is rejected here — send the real secret.
pathPrefixstring | null
A folder inside the bucket to write exports under. A leading slash is stripped and a trailing one added, so /confident-ai is stored as confident-ai/. Omit it, or send null or an empty string, to write to the root of the bucket.
enabledboolean
Whether export schedules may upload to this destination. Defaults to true.

Response

Create Destination succeeded.

successboolean
Indicates if the request was successful.
dataobject
A reference to an export destination by its id.
Show 1 propertyHide 1 property
- idstring
  The id of the destination, generated by Confident AI.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI