LOCURAAPI Reference

OpenAPI 3.1.0

LOCURA DocMaker API

AI document generation platform - company procedures and policies, analyses, audits, offers, contracts, presentations, strategic sessions, articles, bonus systems, gantt charts, transcriptions

Version
1.0.0
Operations
13
Server
https://docmaker.locura.tech
Download JSON

Showing 13 of 13 operations

get/api/v1/document-types

List configurable document type definitions

List declarative document types, immutable versions, dynamic forms, validation rules and output formats

Document TypesBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/document-types/{id}

Get a configurable document type definition

Get versioned definition metadata and documents pinned to a configurable document type

Document TypesBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/documents

List all documents

List documents across all types with pagination. Filter by client_id or type.

DocumentsBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/documents/{id}

Get document details

Get detailed information about a specific document by ID

DocumentsBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/documents/{id}/download

Download document file

Download the generated document file (PDF/PPTX/DOCX/HTML) from R2 storage

DocumentsBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/governance/releases

List document review releases

List versioned review releases with workflow stage, integrity status and open-comment count

GovernanceBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/governance/releases/{id}

Get review release and generation manifest

Get a review release, immutable generation manifest, comments and audit events

GovernanceBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/governance/releases/{id}/snapshot

Get the immutable output snapshot for a review release

Get the exact integrity-verified document snapshot associated with a versioned review release

GovernanceBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/health

Health check

MetaPublic
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/jobs

List generation jobs

List document generation jobs with status tracking and pagination

JobsBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/jobs/{id}

Get job status

Get the status and progress of a specific generation job

JobsBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/templates

List document template families and versions

List executable PDF, PPTX and DOCX templates with immutable version identifiers, hashes and usage counts

TemplatesBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}
get/api/v1/templates/{id}

Get a document template family

Get template versions, renderer metadata and documents pinned to the family

TemplatesBearer API keydocmaker:documents:read
Schema details

Responses

{
  "200": {
    "description": "Success"
  },
  "401": {
    "description": "Unauthorized - missing or invalid API key"
  },
  "403": {
    "description": "Forbidden - missing required scope"
  },
  "429": {
    "description": "Rate limit exceeded"
  },
  "500": {
    "description": "Internal server error"
  }
}