featury API

openapi: 3.1.0
info:
  title: featury API
  version: '2026-11-07'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-07: 13 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; featury has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 12
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-07'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://featury.app/docs/api
  - https://featury.app/en/docs/api
servers:
- url: https://api.featury.app
paths:
  /feed/{ws}/{proj}/og.png:
    get:
      operationId: get_feed_ws_proj_og_png
      tags:
      - Feed
      summary: O changelog publicado de cada produto é servido sem login, em quatro formatos, num endereço estável, e responde a qualquer origem,
        então o seu próprio site pode buscar o JSON e montar uma página com e
      x-source: https://featury.app/docs/api
      parameters:
      - name: ws
        in: path
        required: true
        schema:
          type: string
      - name: proj
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFeedWsProjOgPngResponse'
      x-evidence:
        kind: documentation
  /v1/ask:
    post:
      operationId: post_v1_ask
      tags:
      - Ask
      summary: Pergunte ao agente do código
      x-source: https://featury.app/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1AskRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1AskResponse'
      x-evidence:
        kind: documentation
  /v1/changes:
    get:
      operationId: get_v1_changes
      tags:
      - Changes
      summary: Mudanças classificadas, da mais recente à mais antiga.
      x-source: https://featury.app/docs/api
      parameters:
      - name: workspace
        in: query
        required: false
        schema:
          type: string
        description: slug ou id do workspace
      - name: project
        in: query
        required: false
        schema:
          type: string
        description: slug ou id do projeto
      - name: kind
        in: query
        required: false
        schema:
          type: string
        description: filtra por tipo
      - name: impactSurface
        in: query
        required: false
        schema:
          type: string
        description: filtra por superfície de impacto
      - name: from
        in: query
        required: false
        schema:
          type: string
        description: data inicial
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: data final
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: número máximo de itens (padrão 50, máximo 200)
      - name: offset
        in: query
        required: false
        schema:
          type: string
        description: página de início
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ChangesResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_changes
      tags:
      - Changes
      summary: POST /v1/changes
      x-source: https://featury.app/docs/api
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      - name: project
        in: query
        required: false
        schema:
          type: string
      - name: workspace
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ChangesRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -H "Authorization: Bearer fk_…"  "https://api.featury.app/v1/changes?workspace=acme&project=web&limit=50" 4. Requests Bugs
          e pedidos de feature, de ponta a ponta. Sem filtro de status, a lista retorna só as faixas vivas; repita o parâmetro para filtrar por
          várias. BUILDING e SHIPPED continuam derivados de sinais reais do código, não podem ser definidos manualmente. É a mesma regra do app.
          End'
  /v1/features:
    get:
      operationId: get_v1_features
      tags:
      - Features
      summary: O inventário vivo de features do projeto
      x-source: https://featury.app/docs/api
      parameters:
      - name: workspace
        in: query
        required: false
        schema:
          type: string
        description: slug ou id do workspace
      - name: project
        in: query
        required: false
        schema:
          type: string
        description: slug ou id do projeto
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1FeaturesResponse'
      x-evidence:
        kind: documentation
  /v1/projects:
    get:
      operationId: get_v1_projects
      tags:
      - Projects
      summary: Os projetos a que você tem acesso em um workspace
      x-source: https://featury.app/docs/api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1ProjectsResponse'
      x-evidence:
        kind: documentation
  /v1/requests:
    get:
      operationId: get_v1_requests
      tags:
      - Requests
      summary: Lista requests.
      x-source: https://featury.app/docs/api
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: filtra por status (repetível)
      - name: size
        in: query
        required: false
        schema:
          type: string
        description: filtra por tamanho (repetível)
      - name: impact
        in: query
        required: false
        schema:
          type: string
        description: filtra por impacto (repetível)
      - name: kind
        in: query
        required: false
        schema:
          type: string
        description: filtra por tipo (repetível)
      - name: horizon
        in: query
        required: false
        schema:
          type: string
        description: filtra por horizonte (repetível)
      - name: search
        in: query
        required: false
        schema:
          type: string
        description: texto livre
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: limite de resultados
      - name: offset
        in: query
        required: false
        schema:
          type: string
        description: offset de paginação
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1RequestsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_requests
      tags:
      - Requests
      summary: Registra um request
      x-source: https://featury.app/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1RequestsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1RequestsResponse'
      x-evidence:
        kind: documentation
  /v1/requests/{id}:
    get:
      operationId: get_v1_requests_id
      tags:
      - Requests
      summary: 'Detalhe completo de um request: jornada, comentários, artefatos de spec, reality read'
      x-source: https://featury.app/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1RequestsIdResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_v1_requests_id
      tags:
      - Requests
      summary: Atualiza um request
      x-source: https://featury.app/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchV1RequestsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchV1RequestsIdResponse'
      x-evidence:
        kind: documentation
  /v1/requests/{id}/comments:
    post:
      operationId: post_v1_requests_id_comments
      tags:
      - Requests
      summary: Comenta em um request
      x-source: https://featury.app/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1RequestsIdCommentsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1RequestsIdCommentsResponse'
      x-evidence:
        kind: documentation
  /v1/requests/{id}/status:
    post:
      operationId: post_v1_requests_id_status
      tags:
      - Requests
      summary: Move um request pelas faixas manuais
      x-source: https://featury.app/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1RequestsIdStatusRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1RequestsIdStatusResponse'
      x-evidence:
        kind: documentation
  /v1/workspaces:
    get:
      operationId: get_v1_workspaces
      tags:
      - Workspaces
      summary: Os workspaces de que você faz parte
      x-source: https://featury.app/docs/api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1WorkspacesResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetFeedWsProjOgPngResponse:
      type: object
      properties:
        image:
          type: string
          description: Open Graph PNG image for sharing
    PostV1AskRequest:
      type: object
      properties:
        workspace:
          type: string
          description: slug ou id do workspace
        project:
          type: string
          description: slug ou id do projeto
        question:
          type: string
          description: pergunta
        conversationId:
          type: string
          description: id da conversa para continuação
      required:
      - workspace
      - project
      - question
    PostV1AskResponse:
      type: object
      properties:
        data:
          type: object
          description: contém answer, conversationId e sources
    GetV1ChangesResponse:
      type: object
      properties:
        data:
          type: array
          description: lista de mudanças
    PostV1ChangesRequest:
      type: object
      properties:
        workspace:
          type: string
        project:
          type: string
        kind:
          type: string
        title:
          type: string
    GetV1FeaturesResponse:
      type: object
      properties:
        data:
          type: array
          description: lista de features
    GetV1ProjectsResponse:
      type: object
      properties:
        data:
          type: array
          description: lista de projetos
    GetV1RequestsResponse:
      type: object
      properties:
        data:
          type: array
          description: lista de requests (inclui updatedAt, shippedAt e area)
    PostV1RequestsRequest:
      type: object
      properties:
        workspace:
          type: string
          description: slug ou id do workspace
        project:
          type: string
          description: slug ou id do projeto
        kind:
          type: string
          description: tipo do request
        title:
          type: string
          description: título do request
        body:
          type: string
          description: descrição detalhada
        severity:
          type: string
          description: severidade opcional
      required:
      - workspace
      - project
      - kind
      - title
    PostV1RequestsResponse:
      type: object
      properties:
        data:
          type: object
          description: request criado
    GetV1RequestsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: detalhes completos do request
    PatchV1RequestsIdRequest:
      type: object
      properties:
        title:
          type: string
          description: novo título
        body:
          type: string
          description: nova descrição
        severity:
          type: string
          description: nova severidade
        horizon:
          type: string
          description: override de horizonte
        size:
          type: string
          description: override de tamanho
        fit:
          type: string
          description: override de fit
    PatchV1RequestsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: request atualizado
    PostV1RequestsIdCommentsRequest:
      type: object
      properties:
        body:
          type: string
          description: texto do comentário
      required:
      - body
    PostV1RequestsIdCommentsResponse:
      type: object
      properties:
        data:
          type: object
          description: comentário criado
    PostV1RequestsIdStatusRequest:
      type: object
      properties:
        status:
          type: string
          description: novo status
        note:
          type: string
          description: nota opcional
        declinedReason:
          type: string
          description: razão de recusa opcional
      required:
      - status
    PostV1RequestsIdStatusResponse:
      type: object
      properties:
        data:
          type: object
          description: status atualizado
    GetV1WorkspacesResponse:
      type: object
      properties:
        data:
          type: array
          description: lista de workspaces (id, nome, slug, papel)
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Ask
- name: Changes
- name: Features
- name: Feed
- name: Projects
- name: Requests
- name: Workspaces