Skip to navigation
Paperwork APISpaces

Create a space

View as Markdown

Creates a space: a named container for files and runs that you address explicitly.

Everything the API does without a space happens in a hidden workspace where files are temporary and die with their run. Inside a space it is the other way round — files belong to the space, outlive the runs that produced them, and are indexed for search.

{ "name": "Acme onboarding", "ttl": 604800 }

Lifetime. ttl is seconds from now, from 300 to 7776000 (90 days), and defaults to one week. Once expiresAt passes the space is gone from this API: the next call that addresses it — or DELETE /v1/spaces/{spaceId} — closes it and deletes its files. Extend the deadline at any time with PATCH /v1/spaces/{spaceId}.

Learn more: Spaces

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringOptional1-120 characters
ttlintegerOptional300-7776000
Seconds until the space expires, from now.

Response

The created space.
object"space"
idstring
namestring
createdAtstring
expiresAtstring or null

Errors

400
Bad Request Error
429
Too Many Requests Error