authed

Publish an agent

Changed on

Publish a draft revision of an agent: it becomes the configuration live conversations run. Owners only. Publish only a revision you have just read; one that isn't a draft is refused, and the configuration is checked again, a refused one described problem by problem.

post/api/v1/agent-definitions/{definition_id}/publish

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/agent-definitions/{definition_id}/publish
  • Auth
    none declared

Path parameters

definition_idstring uuid required

The agent's id, as list_agent_definitions returns it.

Request body

revision_idstring uuid required

The draft revision to publish, as get_agent_definition returns it.

Response

Successful Response

idstring uuid required

The agent's id.

organization_idstring uuid required

The organization it belongs to.

slugstring required

The agent's unique short name.

namestring required

The agent's display name.

kind'web' | 'slack' required

Where an agent answers; chosen at creation and never switched.

published_revision_idstring uuid nullable required

The revision live conversations run; null until the agent is first published.

created_atstring date-time required

When the agent was created.

updated_atstring date-time required

When the agent last changed.

Changes

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status

    • info

      removed the STEEP_LEARNING_DISABLED enum value from the / response property for the response status