GAgatana
artifacts

GET /artifacts/{artifactId}

Changed on

Get an artifact with its version history and a frame URL for the requested or current version, honoring its visibility for anonymous callers

Request

  • Base URL
    https://YOUR_ORG_ID.gatana.ai/api/v1
  • URL
    https://YOUR_ORG_ID.gatana.ai/api/v1/artifacts/{artifactId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /oauth/authorize
      Token URL: /oauth/token

Path parameters

artifactIdstring required

Query parameters

versionstring

Version the frame URL should show. Defaults to the current version

Response

Successful response

idstring required
titlestring required
createdByUserIdstring required
createdByUserNamestring required

Display name of the creator, empty when no name is set

createdByUserEmailstring required

Email of the creator

visibility'private' | 'tenant' | 'public' required
themestring required

The theme the artifact is served with: 'gatana', 'none', or the id of an organization theme

currentVersionnumber required
sharedWithUserIdsSchema1264[] required

IDs of the users the artifact is shared with

sharedWithTeamIdsSchema1266[] required

IDs of the teams the artifact is shared with

createdAtstring required
updatedAtstring required
urlstring required

The viewer URL of the artifact on the tenant domain

createdByNamestring required

Display name of the creator, or their email when no name is set

frameUrlstring

Changes

  • 8bae1eeac593Revision changes
    • info

      removed the gatana enum value from the response property for the response status

    • info

      removed the none enum value from the response property for the response status