Documentation

API reference

Retry file archival

POST/v1/files/{file_id}/retry

Historical files for the same account and key. Valid keys with exhausted quota are allowed; revoked/expired keys are still rejected. Downloads require ready; deletion while referenced returns 409. retry only retries saving the original result, not generation. Ordinary APIs use day-based retention, persistent tasks protect references, and expires_at=0 means no fixed expiration.

Recovery after saving fails

Check available space and the error cause first. This operation requests storage capacity again and archives the original result. It neither generates content again nor changes the original task's charges. If the original source has expired, the retry may still fail.

Manage files protected by persistent task references through the task lifecycle; do not delete referenced files to free space. Check billing and storage states separately; see Billing.

Authentication and permissions

Use your current GloopAPI key. Available models, capabilities and permissions depend on its catalog and the endpoint documentation.

Authorization: Bearer $GLOOP_API_KEY

Authentication schemes: BearerAuth

Request

Path parameters

  • file_idstringRequired

    Public ID of a managed file belonging to the same key.

Responses and errors

HTTP 200

File archival retried successfully

application/json

Type
object
Required fields
idsource_kindsource_indexmodelstatusmime_typefile_namesize_bytescreated_atupdated_atexpires_at
  • idstringRequired

    Public identifier of this object, used for its corresponding detail path.

  • source_kindstringRequired

    File source category; determines lifecycle and reference protection rules.

  • source_indexintegerRequired

    Source result item index.

  • modelstringRequired

    Public model ID from the current key's catalog.

  • statusstringRequired

    Background storage stages such as waiting/pending/archiving/ready/failed/deleting; download URLs are only available after ready.

  • mime_typestringRequired

    Verified file MIME type.

  • file_namestringRequired

    Public download filename.

  • sha256stringOptional

    SHA-256 of archived content, returned if determined.

  • size_bytesintegerRequired

    File size in bytes.

  • error_codestringOptional

    Public error code usable for branching logic.

  • created_atintegerRequired

    Creation time in Unix seconds.

  • updated_atintegerRequired

    Last update time in Unix seconds.

  • expires_atintegerRequired

    Unix seconds; 0 means long-term retention. Ordinary APIs follow the deployment's day-based retention policy. Persistent images/videos protect results with references, and deletion still retains billing and idempotency records.

HTTP 400

Invalid request fields or parameters.

application/json

Type
object
Required fields
error

HTTP 401

The key is missing, invalid, expired, or revoked.

application/json

Type
object
Required fields
error

HTTP 403

Insufficient IP, account, model, or tool permissions.

application/json

Type
object
Required fields
error

HTTP 404

Object/capability unavailable, or feature switch disabled.

application/json

Type
object
Required fields
error

HTTP 409

Idempotency/quote conflict, object not ready, or still referenced.

application/json

Type
object
Required fields
error

HTTP 429

Request/queue rate limit.

application/json

Type
object
Required fields
error

HTTP 500

Internal authentication or data storage failure.

application/json

Type
object
Required fields
error

HTTP 503

Service, pricing, or storage unavailable.

application/json

Type
object
Required fields
error