> ## Documentation Index
> Fetch the complete documentation index at: https://docs.refy.to/llms.txt
> Use this file to discover all available pages before exploring further.

# Iniciar nova analise



## OpenAPI

````yaml /openapi/refy-rest.yaml post /v1/workspaces/{workspaceId}/projects/{projectId}/analyses
openapi: 3.1.0
info:
  title: API REST do Refy
  version: 0.1.0
  description: >
    API HTTP orientada a areas de trabalho para autenticacao, analises,
    pontuacao, backlog, monitoramento, cobranca, conectores, eventos e
    notificacoes do Refy.
servers:
  - url: http://localhost:4000
    description: Desenvolvimento local
  - url: https://api.refy.local
    description: URL base ilustrativa de producao
security: []
tags:
  - name: system
    description: Endpoints de sistema, saude da API e utilitarios de ambiente.
  - name: auth
    description: Fluxos de autenticacao, sessao, perfil e onboarding inicial.
  - name: workspaces
    description: Gestao de areas de trabalho, membros, tenancy e chaves de API.
  - name: projects
    description: Gestao de projetos e associacao de membros por projeto.
  - name: analyses
    description: >-
      Analises, dados agregados da tela de analise, evidencias, pontuacao e
      sintese.
  - name: action-points
    description: Backlog de itens de acao, comentarios e checklist operacional.
  - name: monitoring
    description: Monitoramento continuo, runs agendados e alertas.
  - name: billing
    description: Creditos, assinatura, pagamentos, faturas e checkout.
  - name: connectors
    description: Catalogo de conectores e instalacoes por area de trabalho.
  - name: events
    description: Eventos operacionais da area de trabalho.
  - name: notifications
    description: Notificacoes do produto e acoes de leitura e arquivamento.
paths:
  /v1/workspaces/{workspaceId}/projects/{projectId}/analyses:
    post:
      tags:
        - analyses
      summary: Iniciar nova analise
      parameters:
        - $ref: '#/components/parameters/workspaceId'
        - $ref: '#/components/parameters/projectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                inputType:
                  type: string
                inputPayload:
                  type: object
                  additionalProperties: true
                mode:
                  type: string
            examples:
              analyzeUrl:
                value:
                  inputType: url
                  inputPayload:
                    url: https://refy.to/blog/content-audit
                  mode: standard
              analyzeText:
                value:
                  inputType: text
                  inputPayload:
                    text: Texto bruto para revisão editorial
                  mode: deep
      responses:
        '201':
          description: Analise iniciada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Analysis'
      security:
        - bearerAuth: []
components:
  parameters:
    workspaceId:
      name: workspaceId
      in: path
      required: true
      schema:
        type: string
    projectId:
      name: projectId
      in: path
      required: true
      schema:
        type: string
  schemas:
    Analysis:
      type: object
      properties:
        id:
          type: string
        projectId:
          type: string
        inputType:
          type: string
        inputPayload:
          type: object
          additionalProperties: true
        mode:
          type: string
        status:
          type: string
        creditsConsumed:
          type: number
        createdAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
      example:
        id: ana_123
        projectId: prj_123
        inputType: url
        inputPayload:
          url: https://refy.to/blog/content-audit
        mode: standard
        status: completed
        creditsConsumed: 1
        createdAt: '2026-04-28T12:11:00.000Z'
        completedAt: '2026-04-28T12:11:07.000Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Token

````