objects

Create an Object.

Changed on

Create a new Object with content and metadata. The Object will be assigned a unique ID.

post/v1/objects

Request

  • Base URL: https://api.runloop.ai
  • URL: https://api.runloop.ai/v1/objects
  • Auth: HTTP bearer

Request body

namestring required

The name of the Object.

content_type'unspecified' | 'text' | 'binary' | 'gzip' | 'tar' | 'tgz' required
metadataobject nullable

User defined metadata to attach to the object for organization.

ttl_msinteger nullable

Optional lifetime of the object in milliseconds, after which the object is automatically deleted. Time starts ticking after the object is created.

Response

Object created successfully. Returns the Object with metadata.

idstring required

The unique identifier of the Object.

namestring required

The name of the Object.

state'UPLOADING' | 'READ_ONLY' | 'DELETED' | 'ERROR' required
size_bytesinteger nullable

The size of the Object content in bytes (null until uploaded).

content_type'unspecified' | 'text' | 'binary' | 'gzip' | 'tar' | 'tgz' required
create_time_msinteger required

The creation time of the Object in milliseconds since epoch.

delete_after_time_msinteger nullable

The time after which the Object will be deleted in milliseconds since epoch.

metadataobject nullable

User defined metadata to attach to the Object for organization.

upload_urlstring nullable

Presigned URL for uploading content to S3 (only present on create).

Changes