AIair
Showcases

/showcases

Changed on

Create a showcase and its share link in one step.

The showcase starts empty. Add items with POST /v1/showcases/{showcaseId}/assets and POST /v1/showcases/{showcaseId}/boards.

shareLink takes the same settings as a board's share link. password, expiresAt, requireAccount, comments and customFields depend on your workspace's plan; see ShareLinkSettings for what returns 422. If the link cannot be created, the showcase is not created either.

Requires the showcases.write and share_links.write OAuth scopes.

post/v1/showcases

Request

  • Base URL
    api.air.inc (relative, and the document’s source URL is not known)
  • Auth
    • API key in header x-api-key and API key in header x-air-workspace-id
    • or HTTP bearer and API key in header x-air-workspace-id
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

namestring required
descriptionstring

Response

Showcase created successfully

idstring required

The showcase ID

namestring required
descriptionstring nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes