Interloom REST API

preview  

OAS 3.1

Spaces

Endpoints:

• GET /api/v1/public/spaces
  List Spaces Endpoint
• POST /api/v1/public/spaces
  Create Space Endpoint
• GET /api/v1/public/spaces/{space_id}
  Space Endpoint
• PATCH /api/v1/public/spaces/{space_id}
  Update Space Endpoint
• DELETE /api/v1/public/spaces/{space_id}
  Delete Space Endpoint

Cases

Endpoints:

• GET /api/v1/public/cases
  List Cases Endpoint
• POST /api/v1/public/cases
  Create Case Endpoint
• GET /api/v1/public/cases/{case_id}
  Case Endpoint
• PATCH /api/v1/public/cases/{case_id}
  Update Case Endpoint
• DELETE /api/v1/public/cases/{case_id}
  Delete Case Endpoint

Case Ingestion

Endpoints:

• POST /api/v1/public/case-ingestions
  Create Case Ingestion Batch Endpoint
• GET /api/v1/public/case-ingestions/{case_ingestion_id}
  Case Ingestion Batch Endpoint
• GET /api/v1/public/case-ingestions/{case_ingestion_id}/errors
  List Case Ingestion Batch Errors Endpoint

Models

Endpoints:

• GET /api/v1/public/models
  List Models Endpoint

Agents

Endpoints:

• GET /api/v1/public/agents
  List Agents Endpoint
• POST /api/v1/public/agents
  Create Agent Endpoint
• GET /api/v1/public/agents/{agent_id}
  Agent Endpoint
• PATCH /api/v1/public/agents/{agent_id}
  Update Agent Endpoint

Files

Endpoints:

• GET /api/v1/public/files
  List Files Endpoint
• POST /api/v1/public/files
  Upload File Endpoint
• GET /api/v1/public/files/{file_id}
  File Endpoint
• PATCH /api/v1/public/files/{file_id}
  Update File Endpoint
• DELETE /api/v1/public/files/{file_id}
  Delete File Endpoint

Procedures

Endpoints:

• GET /api/v1/public/procedures
  List Procedures Endpoint
• POST /api/v1/public/procedures
  Create Procedure Endpoint
• GET /api/v1/public/procedures/{procedure_id}
  Procedure Endpoint
• PATCH /api/v1/public/procedures/{procedure_id}
  Update Procedure Endpoint
• DELETE /api/v1/public/procedures/{procedure_id}
  Delete Procedure Endpoint

Notes

Endpoints:

• GET /api/v1/public/notes
  List Notes Endpoint
• POST /api/v1/public/notes
  Create Note Endpoint
• GET /api/v1/public/notes/{note_id}
  Note Endpoint
• PATCH /api/v1/public/notes/{note_id}
  Update Note Endpoint
• DELETE /api/v1/public/notes/{note_id}
  Delete Note Endpoint

Parameters

Responses

• Example Value
• Schema

{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid authentication token."
  }
}
``` | _No links_ |
| 404 | Note not found.  
Media type  
application/json  
- Example Value  
- Schema  
```json
{
  "error": {
    "code": "note_not_found",
    "message": "Note not found."
  }
}
``` | _No links_ |
| 422 | Validation Error  
Media type  
application/json  
- Example Value  
- Schema  
```json
{
  "error": {
    "code": "validation_error",
    "fields": [
      {
        "message": "Field required.",
        "path": "title",
        "type": "missing"
      }
    ],
    "message": "The request body is invalid."
  }
}
``` | _No links_ |
| 429 | Too many requests. Try again later.  
Media type  
application/json  
- Example Value  
- Schema  
```json
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Try again later."
  }
}
``` | _No links_ |

### Users

#### Endpoints:
- **GET** [/api/v1/public/users](https://app.interloom.com/api/v1/public/#/Users/listUsers)  
  List Users Endpoint  
- **GET** [/api/v1/public/users/me](https://app.interloom.com/api/v1/public/#/Users/getCurrentUser)  
  Current User Endpoint  
- **GET** [/api/v1/public/users/{user_id}](https://app.interloom.com/api/v1/public/#/Users/getUser)  
  User Endpoint

### Threads

#### Endpoints:
- **GET** [/api/v1/public/threads/{thread_id}](https://app.interloom.com/api/v1/public/#/Threads/getThread)  
  Thread Endpoint  
- **POST** [/api/v1/public/threads/{thread_id}/messages](https://app.interloom.com/api/v1/public/#/Threads/createThreadMessage)  
  Create Thread Message Endpoint  
- **GET** [/api/v1/public/threads/{thread_id}/events](https://app.interloom.com/api/v1/public/#/Threads/listThreadEvents)  
  List Thread Events Endpoint

#### Schemas
- AdditionalMetadata  
- Agent  
- AgentListItem  
- Case  
- CaseIngestion  
- CaseIngestionEntryError  
- CaseIngestionFailedEntry  
- CaseListItem  
- TaskStatus  
- CreateAgentRequest  
- CreateCaseIngestionRequest  
- CreateCaseRequest  
- CreateFileRequest  
- CreateMessageRequest  
- CreateNoteRequest  
- CreateProcedureRequest  
- CreateSpaceRequest  
- CurrentUser  
- File  
- FilePayload  
- ListAgentsResponse  
- ListCaseIngestionErrorsResponse  
- ListCasesResponse  
- ListFilesResponse  
- ListModelsResponse  
- ListNotesResponse  
- ListProceduresResponse  
- ListSpacesResponse  
- ListThreadEventsResponse  
- ListUsersResponse  
- MessagePayload  
- Model  
- ModelCapabilities  
- ModelDeploymentLocation  
- ModelReasoningCapability  
- Note  
- NoteListItem  
- Organization  
- Procedure  
- ProcedureStage  
- ProcedureStagePatchRequest  
- ProcedureSummary  
- ReasoningEffort  
- ResourceLink  
- ResourceType  
- Space  
- SpaceListItem  
- Thread  
- ThreadEvent  
- UpdateAgentRequest  
- UpdateCaseRequest  
- UpdateFileRequest  
- UpdateNoteRequest  
- UpdateProcedureRequest  
- UpdateSpaceRequest  
- User  
- ValidationErrorBody  
- ValidationErrorField  
- ValidationErrorResponse  
- GameObject