v3

latestOpenAPI 3.1.02026-08-0755220214.3 KB

externalStoragePolicies

Create

Creates a new external storage policy in a project. Agents referencing the policy deliver their conversation artifacts to the configured S3-compatible bucket.

post/external_storage_policies

Query parameters

projectstring

The name of the project to create the external storage policy in.

Headers

Authorizationstring required

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Request body

namestring required

The name of the external storage policy. Must be snake_case, start with a lowercase letter and be unique within the project.

endpoint_urlstring required

The S3-compatible endpoint URL that artifacts are uploaded to. Must be a publicly routable HTTPS URL without embedded credentials.

bucketstring required

The bucket that artifacts are uploaded to.

regionstring nullable

The region of the bucket. Set to null when the endpoint doesn't require a region.

key_prefixstring nullable

Prefix prepended to every object key.

addressing_style'auto' | 'virtual' | 'path'

How bucket names are addressed in requests to the endpoint.

access_key_idstring required

Access key ID used to authenticate with the endpoint. Stored encrypted and never returned.

secret_access_keystring required

Secret access key used to authenticate with the endpoint. Stored encrypted and never returned.

Response

Success response

idstring required

The ID of the created external storage policy.

namestring required

The name of the created external storage policy.