API Usage

This page talks about the internal API and how you can use it to interact with Timmy.

The API does not have many public routes and is intended for internal usage within the IT team.

Basic Information

GET http://api.timmy.schoolsimplified.org

Display information about the current Timmy.

200: OK Returns an output of basic identifiable information.

{
    "uptime":"0:10:48",
    "version":"beta3.1.1",
    "author":"School Simplified, IT Dept.",
    "author_email":"[e-mail]",
    "start_time":1659491648.0262012,
    "latency":0.03171817772090435
}

500: Internal Server Error Returns an error message

{
    "error", "Internal Service Error"
}

Send Route

POST http://api.timmy.schoolsimplified.org/send

Send information to TImmy to evalute and execute.

Headers

Name	Type	Description
token*	String	Authentication Token

Request Body

Name	Type	Description
action*	String	Sub-route name.
description*	String	Used for logging: breadcrums.
payload*	String/Dict	Depends on your sub-route, follow the format/instructions given on sub-route commission.
return_post	String	Used for longer running tasks; a URL for the bot to post to upon task completion.
custom_id	String	Used in conjuction with returnpost. If you want Timmy to send a provided custom_id upon completion, provide it here. It's not required but can help with identifying specific requests when done in bulk.

200: OK

{
    // Depends on route
}

422: Unprocessable Entity

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}