Skip to content
fencia.

GITHUB ACTIONS / FENCIA API

Run a document review from a workflow you control

Submit a supported text document to Fencia's API from GitHub Actions and inspect the returned findings. This self-managed example is separate from Fencia's GitHub connector for AI dependency signals.

Find API settings View the example
API access requires an eligible plan. Check your account permissions before setup.
Example run. The workflow file is yours; keep the key in a secret and review every finding before acting.

TWO DISTINCT GITHUB PATHS

Know which GitHub connection you mean

01 / THIS EXAMPLE

Workflow calling the Fencia API

You own the GitHub Actions file and choose which supported document it sends. The API returns analysis for review; Fencia does not publish a GitHub Action package.

02 / CONNECTED SOURCE

GitHub manifest signals

The separate OAuth connector can surface possible AI-use signals from selected dependency manifests in a manual check. It does not import documents or patrol repositories.

EXAMPLE SETUP

A small, inspectable workflow

This manual example scans one TXT file. Choose triggers, file selection and access controls for your own repository. Do not put secrets in the workflow file or print document contents in job logs.

  1. 01

    Check API access

    Create an API key in your Fencia account on a plan that includes API access.

  2. 02

    Store the key as a repository secret

    Name it FENCIA_API_KEY. Restrict who can run a workflow with access to it.

  3. 03

    Review the example, then run it

    Put a supported TXT document at the referenced path. The API uses scan credits and returns a result that still needs human review.

.github/workflows/fencia-review.ymlEXAMPLE · MANUAL TRIGGER
name: Fencia document review
on:
  workflow_dispatch:
permissions:
  contents: read
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Submit a text document
        env:
          FENCIA_API_KEY: ${{ secrets.FENCIA_API_KEY }}
        run: |
          jq -n --arg name "docs/ai-policy.txt" --rawfile text docs/ai-policy.txt '{file_name: $name, text_content: $text}' > request.json
          curl --fail-with-body -sS -H "Authorization: Bearer $FENCIA_API_KEY" -H "Content-Type: application/json" -d @request.json https://fencia.co/api/v1/scan > result.json
          jq '{task_id, status, score, findings_count: (.findings | length)}' result.json

SCOPE & SECURITY

Treat the result as a finding, not a merge verdict

This workflow sends the selected document text to the Fencia API. It does not scan source code, guarantee regulatory compliance or automatically block a pull request. Review the returned source context and your data-handling obligations before using it with sensitive material.

Read about security and subprocessors

READY TO EXPLORE?

Start with a document you can review

Use the API example with a supported file and the right permissions, then decide what the findings mean for your work.