Infoworks

Infoworks Topics API

The Topics API from Infoworks — 9 operation(s) for topics.

GitHub OpenAPI

Operations 13

GET /sources/{source_id}/topic-mappings Get a list of all topics mapping. #
POST /sources/{source_id}/topic-mappings Create Topic Mapping For Source #
GET /sources/{source_id}/topic-mappings/{topic_mapping_id} Get topic mapping id. #
PATCH /sources/{source_id}/topic-mappings/{topic_mapping_id} Update Topic Mapping For Source #
DELETE /sources/{source_id}/topic-mappings/{topic_mapping_id} Delete Topic Mapping For Source #
GET /sources/{source_id}/topics Get topics From Source #
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}/preview Get topic Preview #
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}/crawl-schema Crawl Schema For Topic Mapping #
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}/table-schema Get Table Schema From Mapping #
POST /sources/{source_id}/topic-mappings/{topic_mapping_id}/tables Create Streaming Table #
GET /sources/{source_id}/topic-mappings/{topic_mapping_id}/tables/{table_id} Get Streaming Table #
DELETE /sources/{source_id}/topic-mappings/{topic_mapping_id}/tables/{table_id} Delete Streaming Table #
DELETE /sources/{source_id}/file-mappings/{file_mapping_id}/tables/{table_id} Delete JSON Source Table #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/authentication/infoworks-authentication.yml
📖
Documentation
https://docs.infoworks.io/developer-resources/rest-api
📖
APIReference
https://docs.infoworks.io/infoworks-rest-api-v3/ref

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-topics-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/errors/infoworks-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/conventions/infoworks-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/data-model/infoworks-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/infoworks-topics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

infoworks-topics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Topics API
  version: '1.0'
  description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host:
      default: localhost
    port:
      default: '3001'
tags:
- name: Topics
  description: ''
paths:
  /sources/{source_id}/topic-mappings:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      operationId: getTopicMappingsForSource
      tags:
      - Topics
      summary: Get a list of all topics mapping.
      description: Get a list of all topics mapping.
      responses:
        '200':
          description: Topics Mapping
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    total_count:
                      type: integer
                      minimum: 0
                      description: Total count of topic mappings
                      example: 10
                    result:
                      items:
                        allOf:
                        - properties:
                            name:
                              type: string
                              example: topic_mapping_1
                            configuration:
                              properties:
                                topic_identifier:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                      example: list
                                    list:
                                      type: array
                                      items:
                                        example: person
                                    regex:
                                      type: string
                                      example: ^person
                                    crawl_schema_mechanism:
                                      type: string
                                    subject_name:
                                      type: string
                        - type: object
                          allOf:
                          - type: object
                            properties:
                              created_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                          - type: object
                            properties:
                              created_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                          - type: object
                            properties:
                              modified_at:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                          - type: object
                            properties:
                              modified_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                          json_schema:
                            type: array
                            items:
                              type: object
                              properties:
                                key:
                                  type: integer
                                  example: 1
                                name:
                                  type: string
                                  example: del
                                properties:
                                  type: object
                                  properties:
                                    sql_type:
                                      type: integer
                                      example: 1
                                    target_sql_type:
                                      type: integer
                                      example: 1
                                    type:
                                      type: string
                                      example: struct
                          table_details:
                            type: array
                            items:
                              properties:
                                id:
                                  type: string
                                  example: d04a89ca9d4e9af1b86fdc3e
                                name:
                                  type: string
                                  example: tableName
                                state:
                                  type: string
                                  example: ready
                          deserializer_extension_name:
                            type: string
                            example: Kafka
                          deserializer_function_alias:
                            type: string
                            example: Kafka_function
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    post:
      security:
      - BearerAuth: []
      operationId: createTopicMappingForSource
      tags:
      - Topics
      summary: Create Topic Mapping For Source
      description: Create Topic Mapping For Source
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: topic_mapping_1
                configuration:
                  properties:
                    topic_identifier:
                      type: object
                      properties:
                        type:
                          type: string
                          example: list
                        list:
                          type: array
                          items:
                            example: person
                        regex:
                          type: string
                          example: ^person
                        crawl_schema_mechanism:
                          type: string
                        subject_name:
                          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: string
                      example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topic-mappings/{topic_mapping_id}:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    - name: topic_mapping_id
      in: path
      description: Topic Mapping Id.
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      operationId: getTopicMappingForSource
      tags:
      - Topics
      summary: Get topic mapping id.
      description: Get topic mapping id.
      responses:
        '200':
          description: Topics Mapping Id
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      allOf:
                      - properties:
                          name:
                            type: string
                            example: topic_mapping_1
                          configuration:
                            properties:
                              topic_identifier:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    example: list
                                  list:
                                    type: array
                                    items:
                                      example: person
                                  regex:
                                    type: string
                                    example: ^person
                                  crawl_schema_mechanism:
                                    type: string
                                  subject_name:
                                    type: string
                      - type: object
                        allOf:
                        - type: object
                          properties:
                            created_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                        - type: object
                          properties:
                            created_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                        - type: object
                          properties:
                            modified_at:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                        - type: object
                          properties:
                            modified_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                      properties:
                        id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                        json_schema:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: integer
                                example: 1
                              name:
                                type: string
                                example: del
                              properties:
                                type: object
                                properties:
                                  sql_type:
                                    type: integer
                                    example: 1
                                  target_sql_type:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: struct
                        table_details:
                          type: array
                          items:
                            properties:
                              id:
                                type: string
                                example: d04a89ca9d4e9af1b86fdc3e
                              name:
                                type: string
                                example: tableName
                              state:
                                type: string
                                example: ready
                        deserializer_extension_name:
                          type: string
                          example: Kafka
                        deserializer_function_alias:
                          type: string
                          example: Kafka_function
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    patch:
      security:
      - BearerAuth: []
      operationId: updateTopicMappingForSource
      tags:
      - Topics
      summary: Update Topic Mapping For Source
      description: Update Topic Mapping For Source
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  type: string
                  example: topic_mapping_1
                configuration:
                  properties:
                    topic_identifier:
                      type: object
                      properties:
                        type:
                          type: string
                          example: list
                        list:
                          type: array
                          items:
                            example: person
                        regex:
                          type: string
                          example: ^person
                        crawl_schema_mechanism:
                          type: string
                        subject_name:
                          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: string
                      example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
      - BearerAuth: []
      operationId: deleteTopicMapping
      tags:
      - Topics
      summary: Delete Topic Mapping For Source
      description: Delete Topic Mapping For Source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: string
                      example: e77850ad5127a2d7dab870ff
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/topics:
    parameters:
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      operationId: getTopics
      tags:
      - Topics
      summary: Get topics From Source
      description: Get topics From Source
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
              

# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-topics-api-openapi.yml