v1

latestOpenAPI 3.1.02026-07-26157321426.3 KB

Validates a model push payload and issues upload credentials

post/v1/prepare_model_upload

Request body

namestring nullable

Set to validate a new-model push. Exactly one of name or model_id is required.

team_idstring nullable

Team the new model will belong to. Only valid when name is set; defaults to the organization's default team when omitted. Must not be set when model_id is set (the existing model already has a team).

model_idstring nullable

Set to validate an add-deployment push to an existing model. Exactly one of name or model_id is required.

dry_runboolean

If true, validate the payload only and do not issue upload credentials. The response sets creds, s3_bucket, and s3_key to null.

Response

s3_bucketstring nullable

S3 bucket the credentials are scoped to. Null when no archive upload is required.

s3_keystring nullable

S3 key the credentials are scoped to. Pass this to POST /v1/models (in the model_archive source) once the upload completes. Null when no archive upload is required.

s3_regionstring nullable

AWS region the S3 bucket resides in. Null when no archive upload is required.