api.md

Authors

Types:

• AuthorCreateResponse
• AuthorRetrieveResponse
• AuthorUpdateResponse
• AuthorListResponse
• AuthorDeleteResponse

Methods:

• client.authors.create({ ...params }) -> AuthorCreateResponse
• client.authors.retrieve(id) -> AuthorRetrieveResponse
• client.authors.update(id, { ...params }) -> AuthorUpdateResponse
• client.authors.list({ ...params }) -> AuthorListResponse
• client.authors.delete(id) -> AuthorDeleteResponse

Queue

Types:

• QueueRetrieveResponse
• QueueGetStatsResponse

Methods:

• client.queue.retrieve(id) -> QueueRetrieveResponse
• client.queue.getStats(id, { ...params }) -> QueueGetStatsResponse

Items

Types:

• ItemListResponse
• ItemResolveResponse
• ItemUnresolveResponse

Methods:

• client.queue.items.list(id, { ...params }) -> ItemListResponse
• client.queue.items.resolve(itemID, { ...params }) -> ItemResolveResponse
• client.queue.items.unresolve(itemID, { ...params }) -> ItemUnresolveResponse

Actions

Types:

• ActionCreateResponse
• ActionRetrieveResponse
• ActionUpdateResponse
• ActionListResponse
• ActionDeleteResponse

Methods:

• client.actions.create({ ...params }) -> ActionCreateResponse
• client.actions.retrieve(id) -> ActionRetrieveResponse
• client.actions.update(id, { ...params }) -> ActionUpdateResponse
• client.actions.list({ ...params }) -> ActionListResponse
• client.actions.delete(id) -> ActionDeleteResponse

Execute

Types:

• ExecuteExecuteResponse
• ExecuteExecuteByIDResponse

Methods:

• client.actions.execute.execute({ ...params }) -> ExecuteExecuteResponse
• client.actions.execute.executeByID(actionID, { ...params }) -> ExecuteExecuteByIDResponse

Content

Types:

• ContentSubmitResponse

Methods:

• client.content.submit({ ...params }) -> ContentSubmitResponse

Account

Types:

• AccountListResponse

Methods:

• client.account.list() -> AccountListResponse

Auth

Types:

• AuthCreateResponse
• AuthRetrieveResponse

Methods:

• client.auth.create() -> AuthCreateResponse
• client.auth.retrieve() -> AuthRetrieveResponse

Wordlist

Types:

• WordlistRetrieveResponse
• WordlistUpdateResponse
• WordlistListResponse
• WordlistGetEmbeddingStatusResponse

Methods:

• client.wordlist.retrieve(id) -> WordlistRetrieveResponse
• client.wordlist.update(id, { ...params }) -> WordlistUpdateResponse
• client.wordlist.list() -> WordlistListResponse
• client.wordlist.getEmbeddingStatus(id) -> WordlistGetEmbeddingStatusResponse

Words

Types:

• WordAddResponse
• WordRemoveResponse

Methods:

• client.wordlist.words.add(id, { ...params }) -> WordAddResponse
• client.wordlist.words.remove(id, { ...params }) -> WordRemoveResponse