Conga

Conga Rule Execution API

Provides API endpoints for executing individual playbook rules against contract documents and retrieving clause-level and document-level rule execution results.

GitHub OpenAPI
Business capability
Contract Management BC-150.10

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/clause-rule/{executionId}/results Get a clause rule execution result · Retrieves the clause rule execution result for a specific execution #
Ask an LLM
“What did a clause-level playbook rule find when it ran against my contract?”
“Can I fetch the outcome of one clause rule execution?”
Tell an agent
Get clause rule results for execution {executionId} on contract {contractId}, playbook {playbookId}.
Show the clause rule findings from run {executionId} of playbook {playbookId} on contract {contractId}.
GET /api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/document-rule/{executionId}/results Get a document rule execution result · Retrieves the document rule execution result for a specific execution #
Ask an LLM
“What did a whole-document playbook rule conclude about my contract?”
“Can I retrieve the result of a document rule execution by its ID?”
Tell an agent
Get document rule results for execution {executionId} on contract {contractId}, playbook {playbookId}.
Show the document-level rule outcome of run {executionId} in playbook {playbookId} for contract {contractId}.
POST /api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/{ruleId}/content/run Run a playbook rule on contract document content · Executes a rule against a contract document using the document content #
Ask an LLM
“How do I run a playbook rule against the raw text of a contract document?”
“Can I check an uploaded file's content against one playbook rule?”
Tell an agent
Run rule {ruleId} of playbook {playbookId} on contract {contractId} using content {documentContent}.
Execute playbook {playbookId} rule {ruleId} against file {fileName} for contract {contractId}.
POST /api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/{ruleId}/run Run a playbook rule on pre-extracted rule text · Executes a rule against a contract document using pre-extracted rule text #
Ask an LLM
“Can I run a playbook rule using rule text that was already extracted from the contract?”
“Which smart fields can I pass when executing a rule on extracted text?”
Tell an agent
Run rule {ruleId} of playbook {playbookId} on contract {contractId} with extracted text {ruleText}.
Execute playbook {playbookId} rule {ruleId} on extracted document {executionDocumentId} of contract {contractId}.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-ruleexecution-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-ruleexecution-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-ruleexecution-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: X-Author Rule Execution API
  version: v1
  description: 'Provides API endpoints for executing individual playbook rules against contract documents

    and retrieving clause-level and document-level rule execution results.'
servers:
- url: https://xauthor-prod-rls10.congacloud.com
- url: https://xauthor-preview-rls09.congacloud.com
security:
- bearerAuth: []
tags:
- name: RuleExecution
  description: 'Provides API endpoints for executing individual playbook rules against contract documents

    and retrieving clause-level and document-level rule execution results.'
paths:
  /api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/clause-rule/{executionId}/results:
    get:
      tags:
      - RuleExecution
      summary: Retrieves the clause rule execution result for a specific execution
      parameters:
      - name: executionId
        in: path
        description: The unique identifier of the rule execution.
        required: true
        schema:
          type:
          - string
          - 'null'
          description: The unique identifier of the rule execution.
      - name: contractId
        in: path
        required: true
        schema:
          type: string
      - name: playbookId
        in: path
        required: true
        schema:
          type: string
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ClauseRuleResult'
            application/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ClauseRuleResult'
            text/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ClauseRuleResult'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
      operationId: getApiXauthorV1ContractsByContractIdPlaybooksByPlaybookIdRulesClauseRuleByExecutionIdResults
      x-operation-id-source: derived
  /api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/document-rule/{executionId}/results:
    get:
      tags:
      - RuleExecution
      summary: Retrieves the document rule execution result for a specific execution
      parameters:
      - name: executionId
        in: path
        description: The unique identifier of the rule execution.
        required: true
        schema:
          type:
          - string
          - 'null'
          description: The unique identifier of the rule execution.
      - name: contractId
        in: path
        required: true
        schema:
          type: string
      - name: playbookId
        in: path
        required: true
        schema:
          type: string
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.DocumentRuleResult'
            application/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.DocumentRuleResult'
            text/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.DocumentRuleResult'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
      operationId: getApiXauthorV1ContractsByContractIdPlaybooksByPlaybookIdRulesDocumentRuleByExecutionIdResults
      x-operation-id-source: derived
  /api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/{ruleId}/content/run:
    post:
      tags:
      - RuleExecution
      summary: Executes a rule against a contract document using the document content
      parameters:
      - name: playbookId
        in: path
        description: The unique identifier of the playbook.
        required: true
        schema:
          type:
          - string
          - 'null'
          description: The unique identifier of the playbook.
      - name: ruleId
        in: path
        description: The unique identifier of the rule to execute.
        required: true
        schema:
          type:
          - string
          - 'null'
          description: The unique identifier of the rule to execute.
      - name: contractId
        in: path
        required: true
        schema:
          type: string
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      requestBody:
        description: The request containing the document content and file name.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleOnContentRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleOnContentRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleOnContentRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleOnContentRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecutionDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecutionDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecutionDetails'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
      operationId: postApiXauthorV1ContractsByContractIdPlaybooksByPlaybookIdRulesByRuleIdContentRun
      x-operation-id-source: derived
  /api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/{ruleId}/run:
    post:
      tags:
      - RuleExecution
      summary: Executes a rule against a contract document using pre-extracted rule text
      parameters:
      - name: playbookId
        in: path
        description: The unique identifier of the playbook.
        required: true
        schema:
          type:
          - string
          - 'null'
          description: The unique identifier of the playbook.
      - name: ruleId
        in: path
        description: The unique identifier of the rule to execute.
        required: true
        schema:
          type:
          - string
          - 'null'
          description: The unique identifier of the rule to execute.
      - name: contractId
        in: path
        required: true
        schema:
          type: string
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      requestBody:
        description: The request containing the extraction document ID and rule text.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecutionDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecutionDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ExecutionDetails'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
      operationId: postApiXauthorV1ContractsByContractIdPlaybooksByPlaybookIdRulesByRuleIdRun
      x-operation-id-source: derived
components:
  schemas:
    Conga.XAuthor.Common.Model.AI.Redline.ClauseRuleResult:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        clauseId:
          type:
          - string
          - 'null'
        clauseReferenceId:
          type:
          - string
          - 'null'
        aiSuggestion:
          type:
          - string
          - 'null'
        semanticMatch:
          $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ClauseRuleSimilarity'
        textualMatch:
          $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ClauseRuleSimilarity'
        riskAlignment:
          $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ClauseRuleSimilarity'
        favorableCriteria:
          type:
          - string
          - 'null'
        unfavorableCriteria:
          type:
          - string
          - 'null'
        reviewStatus:
          type:
          - string
          - 'null'
        isNotFoundInDocument:
          type: boolean
        contentControlId:
          type: integer
          format: int64
        isMarkedAsRule:
          type: boolean
        smartFields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ClauseSmartFieldRecommendation'
        suggestionFound:
          type: boolean
      additionalProperties: false
    Conga.XAuthor.Common.Model.AI.Redline.ClauseRuleSimilarity:
      type: object
      properties:
        reason:
          type:
          - string
          - 'null'
        score:
          type:
          - string
          - 'null'
      additionalProperties: false
    Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleRequest:
      type: object
      properties:
        executionDocumentId:
          type:
          - string
          - 'null'
        parentExecutionId:
          type:
          - string
          - 'null'
        ruleText:
          type:
          - string
          - 'null'
        smartFields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Conga.XAuthor.Common.Model.AI.Redline.ClauseSmartField'
      additionalProperties: false
    Conga.XAuthor.Common.Model.AI.Redline.ClauseSmartFieldRecommendation:
      type: object
      properties:
        fieldId:
          type:
          - string
          - 'null'
        fieldName:
          type:
          - string
          - 'null'
        dataType:
          type:
          - string
          - 'null'
        extractedValue:
          type:
          - string
          - 'null'
        recommendedValue:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
      additionalProperties: false
    Conga.XAuthor.Common.Model.AI.Redline.ExecuteRuleOnContentRequest:
      type: object
      properties:
        documentContent:
          type:
          - string
          - 'null'
        fileName:
          type:
          - string
          - 'null'
        parentExecutionId:
          type:
          - string
          - 'null'
      additionalProperties: false
    Conga.XAuthor.Common.Model.AI.Redline.DocumentRuleResult:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        aiSuggestion:
          type:
          - string
          - 'null'
      additionalProperties: false
    Conga.XAuthor.Common.Model.AI.Redline.ExecutionDetails:
      type: object
      properties:
        executionId:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        executionDocumentId:
          type:
          - string
          - 'null'
      additionalProperties: false
    Conga.XAuthor.Common.Model.AI.Redline.ClauseSmartField:
      type: object
      properties:
        fieldId:
          type:
          - string
          - 'null'
        fieldName:
          type:
          - string
          - 'null'
        fieldValue:
          type:
          - string
          - 'null'
        dataType:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT