Faros AI

Faros AI is an engineering-operations intelligence platform (software engineering intelligence / SEI) that ingests data from across the SDLC toolchain into a connected canonical model and exposes it for querying. The platform offers a REST API for events and data ingestion at https://prod.api.faros.ai plus a GraphQL query API over the canonical model, with an open-source Faros Community Edition.

4 APIs 0 Features
Engineering OperationsSoftware Engineering IntelligenceSEIDORA MetricsDeveloper ProductivityData Ingestion

APIs

Faros Events / Ingestion API (REST)

REST API for ingesting events and writing data into the Faros canonical model. Uses an API key passed in the Authorization header against the https://prod.api.faros.ai base URL,...

Faros GraphQL Query API

Hasura-powered GraphQL API for querying the connected canonical model spanning the whole SDLC (50+ entities across VCS, CI/CD, task management, QA, incident management, compute,...

Faros Deployments / CI-CD API

Reports CI (build), CD (deployment), and TestExecution events into the platform to power DORA metrics and delivery analytics. Surfaced through the events ingestion REST API and ...

Faros Webhooks API

Inbound webhook endpoints that let source systems push events into Faros. Each webhook definition provides a unique URL of the form POST /webhooks/{webhook_id}/events for delive...

Collections

Faros AI API

OPEN

GraphQL

Faros AI GraphQL API

Faros AI exposes a native, Hasura-powered GraphQL API over its connected canonical model for the whole software development lifecycle (50+ entities, from tasks to deployments). ...

GRAPHQL

Pricing Plans

Faros Plans Pricing

4 plans

PLANS

Rate Limits

Faros Rate Limits

3 limits

RATE LIMITS

FinOps

Faros Finops

FINOPS

Resources

👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Faros AI API
  version: '1.0'
request:
  auth:
    type: apikey
    key: Authorization
    value: '{{apiKey}}'
    in: header
items:
- info:
    name: Account
    type: folder
  items:
  - info:
      name: Get the current authenticated user.
      type: http
    http:
      method: GET
      url: https://prod.api.faros.ai/users/me
    docs: Returns the identity and account context associated with the API key.
  - info:
      name: List accounts accessible to the caller.
      type: http
    http:
      method: GET
      url: https://prod.api.faros.ai/accounts
    docs: List accounts accessible to the caller.
- info:
    name: Graphs
    type: folder
  items:
  - info:
      name: List graphs in the account.
      type: http
    http:
      method: GET
      url: https://prod.api.faros.ai/graphs
    docs: Lists named graphs; the canonical graph is typically 'default'.
  - info:
      name: Get a single graph.
      type: http
    http:
      method: GET
      url: https://prod.api.faros.ai/graphs/:graph
      params:
      - name: graph
        value: default
        type: path
        description: The name of the graph.
    docs: Get a single graph.
- info:
    name: GraphQL
    type: folder
  items:
  - info:
      name: Execute a GraphQL query or mutation against a graph.
      type: http
    http:
      method: POST
      url: https://prod.api.faros.ai/graphs/:graph/graphql
      params:
      - name: graph
        value: default
        type: path
        description: The name of the graph.
      body:
        type: json
        data: "{\n  \"query\": \"query { cicd_Deployment(limit: 10) { uid status { category } } }\"\n}"
    docs: Hasura-backed GraphQL endpoint over the Faros canonical model.
- info:
    name: Ingestion
    type: folder
  items:
  - info:
      name: List canonical models available in the graph.
      type: http
    http:
      method: GET
      url: https://prod.api.faros.ai/graphs/:graph/models
      params:
      - name: graph
        value: default
        type: path
    docs: List canonical models available in the graph.
  - info:
      name: Write canonical model records into the graph.
      type: http
    http:
      method: POST
      url: https://prod.api.faros.ai/graphs/:graph/models
      params:
      - name: graph
        value: default
        type: path
      body:
        type: json
        data: "{\n  \"origin\": \"my-source\",\n  \"entries\": []\n}"
    docs: Ingests records that conform to the Faros canonical model.
  - info:
      name: Create an ingestion revision.
      type: http
    http:
      method: POST
      url: https://prod.api.faros.ai/graphs/:graph/revisions
      params:
      - name: graph
        value: default
        type: path
      body:
        type: json
        data: '{}'
    docs: Opens a revision that groups a batch of model writes for the graph.
- info:
    name: Events
    type: folder
  items:
  - info:
      name: Report CI/CD and test events to a graph.
      type: http
    http:
      method: POST
      url: https://prod.api.faros.ai/graphs/:graph/events
      params:
      - name: graph
        value: default
        type: path
      body:
        type: json
        data: "{\n  \"origin\": \"my-pipeline\",\n  \"events\": []\n}"
    docs: Reports CI (build), CD (deployment), and TestExecution events into the graph.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: Deliver events to a configured webhook.
      type: http
    http:
      method: POST
      url: https://prod.api.faros.ai/webhooks/:webhook_id/events
      params:
      - name: webhook_id
        value: ''
        type: path
        description: The id from the webhook definition.
      body:
        type: json
        data: '{}'
    docs: Inbound webhook endpoint; source systems POST event payloads here.
bundled: true