fileaify.
Agent protocol

Read how an external agent connects to your workspace, follows the documentation method and submits changes for review.

Give your agent this address: https://fileaify.com/agent/rest

Open raw Markdown← Home

The technical protocol below is maintained in English. This page displays the same source as the raw endpoint used by agents.

Connect a web agent

In your tool’s custom connectors, enter Fileaify and this URL:

https://fileaify.com/mcp

OAuth opens Fileaify to select your workspace, projects, permissions and duration. No secret key to copy. Connecting grants no secret access.

Claude: custom connector with automatic OAuth registration or published identity. ChatGPT: OAuth MCP connector, subject to the features available on your account.

Fileaify agent API — REST operations

Part of the Fileaify agent protocol. Start page and index: /agent. Everything in one document: /agent/full.

REST operations

Every operation below exists as an MCP tool with the same name and the same server-enforced permissions. Replace {…} placeholders with identifiers returned by earlier reads. Details, bodies and error cases are on the pages named in the index of /agent.

MCP tool Method REST path
create_service POST /api/v1/projects/{project_id}/service-proposals
update_service POST /api/v1/projects/{project_id}/services/{service_id}/proposals
list_service_changes GET /api/v1/projects/{project_id}/service-changes
read_service_change GET /api/v1/projects/{project_id}/service-changes/{service_change_id}
list_projects GET /api/v1/projects
read_project GET /api/v1/projects/{project_id}
read_contract GET /api/v1/projects/{project_id}/contract
list_changes GET /api/v1/projects/{project_id}/changes
read_versions GET /api/v1/projects/{project_id}/documents/{document_id}/versions
read_resources GET /api/v1/projects/{project_id}/resources
read_readiness GET /api/v1/projects/{project_id}/readiness
read_references GET /api/v1/projects/{project_id}/references
list_access_requests GET /api/v1/access-requests
submit_changes POST /api/v1/projects/{project_id}/changes
request_access POST /api/v1/projects/{project_id}/access-requests
request_binding POST /api/v1/projects/{project_id}/binding-requests
use_secret POST /api/v1/projects/{project_id}/bindings/{binding_id}/request
export_secret POST /api/v1/projects/{project_id}/bindings/{binding_id}/reveal
create_document POST /api/v1/projects/{project_id}/documents
read_method GET /api/v1/projects/{project_id}/method
read_document GET /api/v1/projects/{project_id}/documents/{document_id}
archive_document POST /api/v1/projects/{project_id}/documents/{document_id}/archive
restore_document POST /api/v1/projects/{project_id}/documents/{document_id}/restore
read_change GET /api/v1/projects/{project_id}/changes/{change_id}
read_changes_summary GET /api/v1/projects/{project_id}/changes/summary
read_attention GET /api/v1/projects/{project_id}/attention
executor_sandbox GET /api/v1/projects/{project_id}/executor/sandbox
executor_targets GET /api/v1/projects/{project_id}/executor/targets
executor_ssh_run POST /api/v1/projects/{project_id}/executor/ssh-run
executor_run POST /api/v1/projects/{project_id}/executor/run
executor_job GET /api/v1/projects/{project_id}/executor/jobs/{job_id}
executor_ssh_access POST /api/v1/projects/{project_id}/executor/ssh-access
executor_ssh_sessions GET /api/v1/projects/{project_id}/executor/ssh-access
executor_ssh_revoke DELETE /api/v1/projects/{project_id}/executor/ssh-access/{session_id}
read_state GET /api/v1/projects/{project_id}/state
read_outline GET /api/v1/projects/{project_id}/documents/{document_id}/outline
archive_sections POST /api/v1/projects/{project_id}/documents/{document_id}/archive-sections

Pairing is REST-only (MCP uses OAuth):

Executor operations are listed above with their MCP tools; details on /agent/executor.