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

# Notebook Configuration

> Retrieves and returns the settings originally configured while initiating the report. Pass the `notebook_id` (report ID) to get all initial configuration attributes used when triggering the workflow.

## Overview

Retrieves and returns the settings you originally configured while initiating the report.

## Endpoint Details

* **Method:** POST
* **Endpoint:** `api/wkl/notebook/configuration/`

## Authentication requirements

* Include a valid JWT token in your request header
* If you don't have a token yet, you can get one from the `/auth/token/` endpoint first.

## Request

### Request Parameters

#### Header Parameters

<ParamField header="Authorization" type="string" required>
  JWT token obtained from the Authentication request
</ParamField>

#### Body Parameters

<ParamField body="notebook_id" type="integer" required>
  Report ID of the notebook for which the configuration is to be retrieved
</ParamField>

## Response

Successful response will contain all the initial configuration attributes added while triggering the workflow.


## OpenAPI

````yaml POST /api/wkl/notebook/configuration/
openapi: 3.0.3
info:
  title: Wokelo API
  description: >
    Wokelo provides four categories of APIs for company and market intelligence:


    1. **Enrichment** – Company and Industry data using Wokelo database and
    alternative data. Supports multi-company requests.

    2. **Discovery** – Workflows for specific use-cases such as market map,
    target screening, and buyer screening.

    3. **Monitoring** – Real-time news monitoring for companies.

    4. **Workflow Automation** – Wokelo and custom research workflows executed
    within notebooks.


    Enrichment and Discovery APIs are managed through async requests; use the
    Supporting APIs to track status and export results in JSON.

    Workflow APIs are executed within notebooks and support export to PDF, PPT,
    DOC, or JSON.


    **Authentication:** All endpoints (except `/auth/token/`) require a Bearer
    JWT token in the `Authorization` header.
  version: 1.0.0
  contact:
    url: https://docs.wokelo.ai/contact
servers:
  - url: https://api.wokelo.ai
    description: Production server
security: []
tags:
  - name: Authentication
    description: Obtain JWT tokens for API access
  - name: Enrichment
    description: Retrieve structured data for companies and industries
  - name: Discovery
    description: Identify companies via market maps, buyer and target screening
  - name: Monitoring
    description: Real-time company news monitoring
  - name: Workflow Automation
    description: Research notebooks for companies, industries, and custom workflows
  - name: Supporting APIs
    description: >-
      Utility endpoints for search, file upload, request management, and report
      retrieval
externalDocs:
  description: Official Wokelo API Documentation
  url: https://docs.wokelo.ai/overview
paths:
  /api/wkl/notebook/configuration/:
    post:
      tags:
        - Supporting APIs
      summary: Notebook Configuration
      description: >-
        Retrieves and returns the settings originally configured while
        initiating the report. Pass the `notebook_id` (report ID) to get all
        initial configuration attributes used when triggering the workflow.
      operationId: notebookConfiguration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - notebook_id
              properties:
                notebook_id:
                  type: integer
                  description: >-
                    Report ID of the notebook for which the configuration is to
                    be retrieved.
                  example: 103737
            example:
              notebook_id: 103737
      responses:
        '200':
          description: >-
            Notebook configuration retrieved successfully. Returns all initial
            configuration attributes used when the workflow was triggered.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  All initial configuration attributes added while triggering
                  the workflow.
                additionalProperties: true
        '400':
          description: Bad request – missing or invalid `notebook_id`
        '401':
          description: Unauthorized – invalid or missing JWT token
        '404':
          description: Notebook not found
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from the `/auth/token/` endpoint.

````