Service API

Path or query parameters are delimited by curly braces.

user resources represent Quo users.

• /users
  • POST creates a user; 201 on success with user URL in Location header
• /users/{username}
  • GET returns the data for the user with the given {username}
  • PUT creates or updates a user with the given {username}; 201 on successful create, 204 on successful update. The password property is optional; if blank or not included, the current password is preserved.

status resources are status posts made by Quo users. At the moment, these are write-only: i.e., you can only post to this resource. The statuses then find their way to whatever destinations are configured for the current user.

• /statuses
  • POST sends a message to the current user's configured services.

function resources are string transformers: they take one string and produce another.

• /functions
• /functions?q={search term}
• /functions/{id}

destination resources are the final “sinks” for status posts. They represent social network or other services to which Quo user status posts can be sent.

• /destinations

pipeline resources are the chains of functions through which status posts travel before getting sent to their destinations. In a sense, they are programs with specific input (a string) and specific output (API calls to destinations for posting the final, transformed status string).

• /pipelines
• /pipelines?user={username}
• /pipelines/{id}