Skip to content
Staircase

Workspace assistant

Products

The assistant inside the internal workspace: answers a reviewer's questions about an application in progress and drafts the message going back to the borrower.

Used when
While a person is working an application, rather than while a borrower is answering one.
Collects
  • The reviewer's question, and the application it is about.
Returns
  • The answer, and the draft reply for the reviewer to send or edit.
Evidence
  • aira
  • aira-messaging

Operations

Workspaces

POST /

Create a new workspace

createWorkspace

Request
application/json 
{
  "name": "Agent",
  "default_assistant": {"assistant_name": "leadsGeneric", "context_message": "Questions related to leads."},
  "assistants": [
    {"assistant_name": "SendEmail", "context_message": "Questions related to sending emails."},
    {"assistant_name": "GeneratePostcard", "context_message": "Questions related to generating postcards."}
  ]
}
Request bodyapplication/json
4 fields
FieldTypeDescription
namerequiredstringName of the workspace
default_assistantobjectAssistant object
assistant_namestringName of the assistant
context_messagestringContext message for the assistant
assistantsrequiredarrayList of assistants for the workspace
routing_modelstringRouting model. Only GPT-4o and later models are supported. GPT4-4o mini is also supported.
Response 200application/json
4 fields

Ok.

FieldTypeDescription
namerequiredstringName of the workspace
default_assistantobjectAssistant object
assistant_namestringName of the assistant
context_messagestringContext message for the assistant
assistantsrequiredarrayList of assistants for the workspace
routing_modelstringRouting model. Only GPT-4o and later models are supported. GPT4-4o mini is also supported.
GET /{workspace_name}

Get a workspace

getWorkspace

Get a workspace by name

Parameters
1
ParameterTypeExampleDescription
workspace_name required string path my-workspace Name of the workspace
Response 200application/json
4 fields

Ok.

FieldTypeDescription
namerequiredstringName of the workspace
default_assistantobjectAssistant object
assistant_namestringName of the assistant
context_messagestringContext message for the assistant
assistantsrequiredarrayList of assistants for the workspace
routing_modelstringRouting model. Only GPT-4o and later models are supported. GPT4-4o mini is also supported.

AIRA Messaging

POST /messaging/{workspace_name}/messages

Send message

sendMessage

Send a message to the AIRA workspace

Request
application/json 
{
  "connection_id": "123",
  "x-sc-trace-id": "123",
  "message": [
    {
      "type": "text",
      "text": "Hello"
    }
  ],
  "payload": {
    "person_identifier": "123",
    "regenerate_response": true
  }
}
Parameters
1
ParameterTypeExampleDescription
workspace_name required string path workspace The name of the workspace
Request bodyapplication/json
4 fields
FieldTypeDescription
connection_idrequiredstringThe connection id
x-sc-trace-idstringThe trace id
messagerequiredobject[]The message to send
typerequiredstringThe type of the messagetext
textrequiredstringThe content of the message
payloadrequiredobjectThe payload
person_identifierrequiredstringThe person identifier
regenerate_responsebooleanRegenerate the response
Response 400application/json
1 fields

Bad Request

FieldTypeDescription
messagestringThe error message
Response 403application/json
1 fields

Forbidden

FieldTypeDescription
messagestringThe error message
Other responses

200

GET /messaging/{connection_id}/messages

List messages by connection ID

listMessages

List messages

List messages by connection id

Response
application/json

Messages history

{
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    },
    {
      "role": "assistant",
      "content": "Hi"
    }
  ],
  "openai_thread_id": "123"
}
Parameters
1
ParameterTypeExampleDescription
connection_id required string path dfYn_eqooAMCFDA= The connection id
Response 200application/json
2 fields

Messages history

FieldTypeDescription
messagesobject[]The messages
rolestringThe roleuserassistant
contentstringThe content
openai_thread_idstringThe openai thread id

Route

POST /{workspace_name}/route

Process route request

processRouteRequest

Process a route request

Process a route request for the specified workspace

Request
application/json 
{
  "message_history": [{"role": "System", "content": ""}, {"role": "System", "content": ""}],
  "input_text": ""
}
Parameters
1
ParameterTypeExampleDescription
workspace_name required string path my-workspace Name of the workspace to route the request to
Request bodyapplication/json
2 fields
FieldTypeDescription
input_textstringInput text for the route
message_historyobject[]Message history
rolestringRole of the messageassistantuser
contentstringText of the message
Response 200application/json
3 fields

Ok.

FieldTypeDescription
openai_assistant_idstringOpenAI assistant ID
configuration_idstringConfiguration ID
assistant_namestringStaircase assistant name

Others in Products

Type to search.