Initiate a download

post/download-requests

Request

Base URL
http://localhost:6286
Auth
none declared
TypeScript
https://skmtc.dev/iconik/apis/agent-api/docs/download-requests/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

open_in_fcpstring

If set to 1 or true, the Agent will try to open the downloaded asset in FCP

resolve_on_local_isgstring

If set to 1 or true, the Agent will try to resolve the download on the local ISG.

Headers

app-idstring

App ID for the auth token

iconik-hoststring

Host of the Iconik system the token belongs to, for example app.iconik.io. The Agent only uses the token headers below when this and app-id are both set.

auth-tokenstring

Optionally pass an auth token when initiating a download. This will try to log in the Agent using this token. If another user is already logged in the Agent will ask the user to confirm the switch of user.

share-auth-tokenstring

Share token to authenticate the Agent with, used instead of auth-token when downloading from a share.

share-hashstring

Hash of a public share to authenticate the Agent with, used instead of auth-token when downloading from a share.

Request body

Response

Response when adding a download request

idstring required

titlestring required

Changes

No recorded changes to this operation across all 1 revision of this API.