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

# Welcome

The Skill Engine API is an AI toolkit to solve your skill-related challenges.
Our aim is twofold. Firstly, we want to explain how individual components work.
Secondly, we want to demonstrate how to assemble these components into a
complete use case. This section of the developer portal provides a range of
tutorials, showcasing the information flow and API calls needed to bring these
scenarios to life.

In each tutorial, the two communicating parties are <b>your system</b> and
the <b>Skill Engine API</b>. A diagram shows the flow of the requests. For all
requests, the message arrow indicates the corresponding method and endpoint.
Responses are shown as a dotted line, indicating the HTTP response code. The
following image shows an example of a request flow diagram:

```mermaid theme={null}
sequenceDiagram
    participant Your System
    participant Skill Engine API
    Your System->>Skill Engine API: POST /employees
    activate Your System
    alt Creation Successful
        rect rgba(0, 255, 0, .15)
            Skill Engine API->>Skill Engine API: Skill Extraction
            Skill Engine API-->>Your System: ✅ HTTP 204 No Content
        end
    else Entity Already Exists
        rect rgba(255, 0, 0, .15)
            Skill Engine API-->>Your System: ❌ HTTP 409 Conflict
        end
    end
```

Keep the following rules in mind when reading sequence diagrams:

* `opt` indicates optional operations (e.g. a feedback step).
* `alt` indicates scenarios that are alternatives to each other (
  e.g. a success and failure scenario).
* Colours are meaningful: <b>green</b> indicates a success scenario, <b>red</b>
  indicates a critical failure (which ends the flow immediately), <b>orange</b>
  indicates a non-critical failure (which means an operation has no effect, but
  the flow can continue).
* In more complex setups, only success paths are visible. For a complete
  overview of the scenarios in those cases, please consult the API spec.

##
