Sideko REST API Python SDK

Overview

The Sideko API unlocks features including generating SDKs, setting up API Specifications with mock servers, creating documentation projects with generated API references and custom pages, managing roles and permissions, and more.

Synchronous Client

from sideko_portal import SidekoClient
from os import getenv

client = SidekoClient(api_key=getenv("API_KEY"))

Asynchronous Client

from sideko_portal import AsyncSidekoClient
from os import getenv

client = AsyncSidekoClient(api_key=getenv("API_KEY"))

Module Documentation and Snippets

api

• create - Create a new API
• delete - Delete an API
• get - Get one API
• init - Create an API with an initial version
• list - List your APIs
• patch - Update an existing API

api.spec

• create - Add a new API specification
• delete - Delete an API Specification and it's associated metadata
• get - Get API specification metadata
• get_openapi - Get OpenAPI specification
• get_stats - Get Stats about the specification
• list - List specs of a collection
• patch - Update an API Specification and/or metadata

api_link

• create - Links API Version to Documentation project version with a specified update policy
• delete - Removes an API link
• get - Retrieve single API link
• list - List API links for doc version
• patch - Updates an API link
• reorder - Reorder API links and groups

api_link.group

• create - Create API group to organize API links
• delete - Deletes the api group and all its links
• list - List API groups for doc version
• patch - Updates API link group

asset

• create - Upload Assets
• delete - Delete Asset
• list - List Assets
• patch - Update Asset

auth

• exchange_code - Exchange one-time auth key for api key

cli

• check_updates - Checks if current CLI has updates

doc

• check_preview - A simple check to see if the requesting user has access to the preview doc project
• create - Create a new Documentation Project
• delete - Delete a specific Documentation Project
• get - Get a specific Documentation Project
• list - List Documentation Projects
• patch - Update an existing Documentation Project

doc.deployment

• get - Get a specific deployment for a specific documentation project
• list - List deployments for a specific documentation project
• trigger - Deploy a new generated version of documentation with linked guides & APIs

doc.preview

• create_password - A password generator for a documentation project preview environment
• delete_password - Deletes a preview environment password
• list_passwords - Lists generated passwords for a documentation project preview environment

doc.theme

• get - Get the theme attached to a documentation project
• update - Update a document project theme

doc.version

• get - Get a specific version of an Documentation Project
• list - List versions of a specific Documentation Project

doc.version.guide

• create - Create a guide for a specific version of a documentation project
• delete - Delete a specific guide for a specific version of a documentation project
• get - Get a specific guide for a specific version of a documentation project
• get_content - Get content for a specific guide for a specific version of a documentation project
• list - List guides for a specific version of a documentation project
• patch - Update a specific guide for a specific version of a documentation project
• reorder - Reorder guides for a specific version of a documentation project

lint

• run - Lint an OpenAPI spec

org

• create - Create a new organization
• get - Get Organization

org.theme

• get - Get organization theme
• update - Update organization theme

role

• create - Create a new role
• delete - Delete role and all associated permissions
• list - List roles

sdk

• generate - Generate a new managed SDK from a Sideko configuration file
• list - List all managed SDKs
• update - Update an SDK to reflect the latest state of the API

sdk.config

• init - Initialize an SDK configuration with all defaults applied
• sync - Sync an SDK configuration with the latest state of the API

sdk.doc

• create - Retrieve SDK documentation

service_account

• create - Create a new service account with a set of project permissions
• delete - Delete a service account
• get - Get service account by the ID
• list - List all service accounts in organization

user

• invite - Invite a user to an organization with a specific role

user.me

• get - Get current user profile
• get_key - Get API key for the current user