Skip to main content

socaity-cli

The command line for the socaity.ai platform: login, catalog browsing, socaity run, and APIPod deployment tooling. One socaity command, shared by the socaity SDK and APIPod.

The package is deliberately small: httpx2 and socaity-schemas are the only dependencies. Commands that need more (SDK run, container builds) delegate to the socaity or apipod package and tell you what to install when it is missing.

Install

pip install socaity-cli

You get socaity-cli as part of pip install socaity or pip install apipod as well.

Commands

Command Needs What it does
socaity login / logout / whoami - Browser login, credentials in ~/.config/socaity/
socaity list services|models - Browse the AI catalog
socaity search "flux schnel" - Typo-tolerant search (--collections services,models,jobs)
socaity jobs [job_id] login List/search jobs; --q, --expand data,files,billing,social, --visibility
socaity projects [project_id] login Your projects; --expand jobs embeds member jobs
socaity run <target> socaity Catalog job, agent turn, or workflow run
socaity connector add <url> login Register an HTTP API (OpenAPI URL, docs page or API root) or MCP server as a private connector; --token-env NAME or --oauth
socaity connector auth <service_id> login Change the connector's credential: --token-env NAME or --oauth (prints and opens the authorize URL)
socaity connector disconnect <service_id> login Remove your credential binding; connector and vault row stay
socaity scan apipod Scan a project and generate apipod.json
socaity build [file] apipod Build the deployment container
socaity start [entrypoint] apipod Run an APIPod service locally
socaity deploy [target] apipod Deploy to Socaity (wraps apipod deploy)

Use --project-dir DIR with scan/build/start/deploy to point at a service project directory (e.g. socaity --project-dir simple_test_service deploy serverless-runpod --yes).

Configuration

Env var Default Purpose
SOCAITY_API_KEY from login API key (wins over stored credentials)
SOCAITY_BACKEND_URL https://webapi.socaity.ai Platform API (env wins; login file is fallback only, never written into the process)
SOCAITY_FRONTEND_URL https://socaity.ai Web UI for browser login

Using it as a library

socaity and apipod build on the same primitives this package exposes:

from socaity_cli import SocaityBackendClient, get_api_key, requires

SocaityBackendClient covers catalog reads, search, and connectors (inspect_connector, register_connector, change_connector_credential, disconnect_connector_credential). The first three stream server-sent events to on_event (progress, authorize); inspect writes no catalog row. Catalog rows are Service models: details[] holds the spec plus a nested deployment or connector for the URL. details[0] is the binding unpinned calls use. Pass it as details_id to pin the spec. Resume a deploy with deployment_id (that binding's deployment.id). Connectors are services with kind == "connector". requires("apipod") guards a function behind an optional package with a friendly install hint instead of an ImportError traceback.

Metadata

Release files for socaity-cli 0.1.14

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for socaity-cli 0.1.14
File Size Uploaded
socaity_cli-0.1.14.tar.gz 45.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for socaity-cli 0.1.14
File Interpreter ABI Platform
socaity_cli-0.1.14-py3-none-any.whl Python 3 none any Details

Total release size: 98.9 kB

Release files / socaity_cli-0.1.14.tar.gz

Download URL socaity_cli-0.1.14.tar.gz
Size 45.9 kB
Tags Source
SHA-256 checksum
How to use checksums
644abb7b8cfdd408ff741fc90d32a81c10490daf5805d00d5ffdde3a62027ba3
BLAKE2b-256 checksum
How to use checksums
576f13533df4e4e85bffee9acd8cef1d8ee475c8565996295c3712345034770c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / socaity_cli-0.1.14-py3-none-any.whl

Download URL socaity_cli-0.1.14-py3-none-any.whl
Size 53.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e50141b7dd513b8783916eca6b14ba637a4c7a4c43d9728f09075895247a1d6e
BLAKE2b-256 checksum
How to use checksums
33bbb6fc652d6feb0748f081406027b1e0b5c548a250b1d1b1331a92bf904732
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release history Release notifications | RSS feed

This release

0.1.14 This release

2 release files

0.1.13

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page