Resource endpoints

All endpoints in this section use bearer auth and return the standard /v1 envelope.

Use this page when your integration needs to read the state of a workspace, project, task queue, file set, entity graph, or findings. The easiest way to think about it is by question:

• “What is configured?” -> workspace-scoped configuration
• “What is happening in this deal?” -> projects, tasks, reports
• “What evidence do we have?” -> files
• “What risk and structure does that evidence imply?” -> entities, analyses, findings

Workspace-scoped configuration

Method	Path	What it returns	Notes
GET	/v1/workspaces/{workspaceUuid}/diligence-settings	Workspace diligence defaults	Returns the workspace summary plus the settings object
GET	/v1/workspaces/{workspaceUuid}/ai-settings	Workspace AI defaults	Includes language and global AI instructions
GET	/v1/workspaces/{workspaceUuid}/ai-prompts	Saved AI prompts	Ordered by most recently updated
GET	/v1/workspaces/{workspaceUuid}/workflow-settings	Task workflows, project workflows, automation preferences	Use this for status modeling
GET	/v1/workspaces/{workspaceUuid}/property-definitions	Custom property definitions	Optional resourceType filter

Projects, tasks, reports, and templates

Method	Path	What it returns	Notes
GET	/v1/projects	Project list	Supports workspaceId, limit, cursor
GET	/v1/projects/{projectId}	Full project detail	Includes metadata, milestones, writers, permissions, custom properties
GET	/v1/projects/{projectId}/diligence-settings	Effective diligence settings for one project	Merges workspace defaults with project overrides
GET	/v1/projects/{projectId}/bundle	Project summary bundle	Includes tasks, files, entities, open requests, findings, analyses
GET	/v1/projects/{projectId}/qoe	QoE analysis payload	Analysis-backed rather than a separate resource type
GET	/v1/tasks	Task list	Optional projectId, plus limit and cursor
GET	/v1/tasks/{taskId}	One task	Returns task summary and status
GET	/v1/reports	Report list	Optional projectId, plus limit and cursor
GET	/v1/reports/{reportId}	One report	Full report summary payload
GET	/v1/report-templates	Built-in report templates	Optional phase=PHASE_1 or PHASE_2
GET	/v1/templates	Workspace text templates	Workspace-scoped reusable text assets
GET	/v1/templates/{templateUuid}	One workspace template	UUID-based path, not a TMP- prefix

Files

Method	Path	What it returns	Notes
POST	/v1/files/search	Ranked file search results	Supports workspaceId, query, optional projectId or taskId
GET	/v1/files	Standalone project file list	Supports workspaceId, optional projectId, limit
GET	/v1/files/{fileId}	One file detail	Includes freshness metadata
GET	/v1/files/{fileId}/content	Text chunk, image URL, or fallback	Supports cursor and maxChars for text responses
GET	/v1/files/{fileId}/structured	File metadata plus analyses	Good for machine inspection of file-derived output
GET	/v1/files/{fileId}/status	Processing state and analysis summary	Includes latest file-version ID and red-flag count
GET	/v1/files/{fileId}/entities	Extracted entities and relationships for one file	Returns both entity rows and relationship rows

File content example

curl "$COLABRA_API_URL/v1/files/FIL-104/content?workspaceId=$WORKSPACE_ID&maxChars=4000" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Entities, analyses, and findings

Method	Path	What it returns	Notes
GET	/v1/entities	Workspace entity list or project entity list	Optional projectId; project mode also supports `scope=all
POST	/v1/entities/search	Ranked entity search results	Supports workspaceId, query, limit
GET	/v1/entities/{entityId}	One entity	Includes risk verdicts and enrichment timestamps
GET	/v1/entities/{entityId}/risk	Risk-domain payload	Optional domain query; all returns all domains
GET	/v1/entities/{entityId}/files	Linked files for the entity	Includes file ID, raw file ID, version, and title
GET	/v1/entities/{entityId}/graph	Relationship graph	Returns source and target relationships
GET	/v1/entities/{entityId}/bundle	Entity bundle	Includes risk domains, linked files, graph edges, findings, analyses
GET	/v1/analyses	Analyses for a target resource	Requires targetId
GET	/v1/analyses/{analysisId}	One analysis payload	Analysis IDs are URL-encoded
GET	/v1/findings	Findings for a target resource	Requires targetId
GET	/v1/findings/{findingId}	One finding	Also requires targetId

Search endpoints return ranked snippets

Both search endpoints return ranked rows with:

• a public ID
• score
• matched fields
• snippet

That makes them useful for assistants, automations, and UI handoff flows instead of only human search boxes.

If you are building an assistant or review tool, start with the search endpoints and then fan out to resource detail only for the items that matter.